diff --git a/node_modules/.package-lock.json b/node_modules/.package-lock.json index 140bdaa7..71d656c0 100644 --- a/node_modules/.package-lock.json +++ b/node_modules/.package-lock.json @@ -4,9 +4,9 @@ "requires": true, "packages": { "node_modules/@actions/artifact": { - "version": "2.1.11", - "resolved": "https://registry.npmjs.org/@actions/artifact/-/artifact-2.1.11.tgz", - "integrity": "sha512-V/N/3yM3oLxozq2dpdGqbd/39UbDOR54bF25vYsvn3QZnyZERSzPjTAAwpGzdcwESye9G7vnuhPiKQACEuBQpg==", + "version": "2.2.1", + "resolved": "https://registry.npmjs.org/@actions/artifact/-/artifact-2.2.1.tgz", + "integrity": "sha512-V2cvKJ+Evg2n9Mcqz7kjbY2s0nd9MsBI2rw2E38pSEMv+Coo4i1sX0lyGcgSn1zyfVtmLwAI9LfuSptWF8PdaA==", "license": "MIT", "dependencies": { "@actions/core": "^1.10.0", @@ -122,9 +122,9 @@ } }, "node_modules/@actions/github/node_modules/@octokit/openapi-types": { - "version": "22.2.0", - "resolved": "https://registry.npmjs.org/@octokit/openapi-types/-/openapi-types-22.2.0.tgz", - "integrity": "sha512-QBhVjcUa9W7Wwhm6DBFu6ZZ+1/t/oYxqc2tp81Pi41YNuJinbFRx8B133qVOrAaBbF7D/m0Et6f9/pZt9Rc+tg==", + "version": "23.0.1", + "resolved": "https://registry.npmjs.org/@octokit/openapi-types/-/openapi-types-23.0.1.tgz", + "integrity": "sha512-izFjMJ1sir0jn0ldEKhZ7xegCTj/ObmEDlEfpFrx4k/JyZSMRHbO3/rBwgE7f3m2DHt+RrNGIVw4wSmwnm3t/g==", "license": "MIT" }, "node_modules/@actions/github/node_modules/@octokit/plugin-paginate-rest": { @@ -203,12 +203,12 @@ } }, "node_modules/@actions/github/node_modules/@octokit/types": { - "version": "13.6.2", - "resolved": "https://registry.npmjs.org/@octokit/types/-/types-13.6.2.tgz", - "integrity": "sha512-WpbZfZUcZU77DrSW4wbsSgTPfKcp286q3ItaIgvSbBpZJlu6mnYXAkjZz6LVZPXkEvLIM8McanyZejKTYUHipA==", + "version": "13.7.0", + "resolved": "https://registry.npmjs.org/@octokit/types/-/types-13.7.0.tgz", + "integrity": "sha512-BXfRP+3P3IN6fd4uF3SniaHKOO4UXWBfkdR3vA8mIvaoO/wLjGN5qivUtW0QRitBHHMcfC41SLhNVYIZZE+wkA==", "license": "MIT", "dependencies": { - "@octokit/openapi-types": "^22.2.0" + "@octokit/openapi-types": "^23.0.1" } }, "node_modules/@actions/http-client": { @@ -313,9 +313,9 @@ } }, "node_modules/@azure/core-rest-pipeline": { - "version": "1.18.1", - "resolved": "https://registry.npmjs.org/@azure/core-rest-pipeline/-/core-rest-pipeline-1.18.1.tgz", - "integrity": "sha512-/wS73UEDrxroUEVywEm7J0p2c+IIiVxyfigCGfsKvCxxCET4V/Hef2aURqltrXMRjNmdmt5IuOgIpl8f6xdO5A==", + "version": "1.18.2", + "resolved": "https://registry.npmjs.org/@azure/core-rest-pipeline/-/core-rest-pipeline-1.18.2.tgz", + "integrity": "sha512-IkTf/DWKyCklEtN/WYW3lqEsIaUDshlzWRlZNNwSYtFcCBQz++OtOjxNpm8rr1VcbMS6RpjybQa3u6B6nG0zNw==", "license": "MIT", "dependencies": { "@azure/abort-controller": "^2.0.0", @@ -567,18 +567,18 @@ } }, "node_modules/@octokit/request-error/node_modules/@octokit/openapi-types": { - "version": "22.2.0", - "resolved": "https://registry.npmjs.org/@octokit/openapi-types/-/openapi-types-22.2.0.tgz", - "integrity": "sha512-QBhVjcUa9W7Wwhm6DBFu6ZZ+1/t/oYxqc2tp81Pi41YNuJinbFRx8B133qVOrAaBbF7D/m0Et6f9/pZt9Rc+tg==", + "version": "23.0.1", + "resolved": "https://registry.npmjs.org/@octokit/openapi-types/-/openapi-types-23.0.1.tgz", + "integrity": "sha512-izFjMJ1sir0jn0ldEKhZ7xegCTj/ObmEDlEfpFrx4k/JyZSMRHbO3/rBwgE7f3m2DHt+RrNGIVw4wSmwnm3t/g==", "license": "MIT" }, "node_modules/@octokit/request-error/node_modules/@octokit/types": { - "version": "13.6.2", - "resolved": "https://registry.npmjs.org/@octokit/types/-/types-13.6.2.tgz", - "integrity": "sha512-WpbZfZUcZU77DrSW4wbsSgTPfKcp286q3ItaIgvSbBpZJlu6mnYXAkjZz6LVZPXkEvLIM8McanyZejKTYUHipA==", + "version": "13.7.0", + "resolved": "https://registry.npmjs.org/@octokit/types/-/types-13.7.0.tgz", + "integrity": "sha512-BXfRP+3P3IN6fd4uF3SniaHKOO4UXWBfkdR3vA8mIvaoO/wLjGN5qivUtW0QRitBHHMcfC41SLhNVYIZZE+wkA==", "license": "MIT", "dependencies": { - "@octokit/openapi-types": "^22.2.0" + "@octokit/openapi-types": "^23.0.1" } }, "node_modules/@octokit/request/node_modules/@octokit/request-error": { @@ -684,13 +684,10 @@ } }, "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==", + "version": "7.1.3", + "resolved": "https://registry.npmjs.org/agent-base/-/agent-base-7.1.3.tgz", + "integrity": "sha512-jRR5wdylq8CkOe6hei19GGZnxM6rBGwFl3Bg0YItGDimvjGtAvdZk4Pu6Cl4u4Igsws4a1fd1Vq3ezrhn4KmFw==", "license": "MIT", - "dependencies": { - "debug": "^4.3.4" - }, "engines": { "node": ">= 14" } @@ -774,9 +771,9 @@ "license": "MIT" }, "node_modules/bare-events": { - "version": "2.5.0", - "resolved": "https://registry.npmjs.org/bare-events/-/bare-events-2.5.0.tgz", - "integrity": "sha512-/E8dDe9dsbLyh2qrZ64PEPadOQ0F4gbl1sUJOrmph7xOiIxfY8vwab/4bFLh4Y88/Hk/ujKcrQKc+ps0mv873A==", + "version": "2.5.4", + "resolved": "https://registry.npmjs.org/bare-events/-/bare-events-2.5.4.tgz", + "integrity": "sha512-+gFfDkR8pj4/TrWCGUGWmJIkBwuxPS5F+a5yWjOHQt2hHvNZd5YLzadjmDUtFmMM4y429bnKLa8bYBMHcYdnQA==", "license": "Apache-2.0", "optional": true }, @@ -992,9 +989,9 @@ } }, "node_modules/debug": { - "version": "4.3.7", - "resolved": "https://registry.npmjs.org/debug/-/debug-4.3.7.tgz", - "integrity": "sha512-Er2nc/H7RrMXZBFCEim6TCmMk02Z8vLC2Rbi1KEBggpo0fS6l0S1nnapwmIi3yW/+GOJap1Krg4w0Hg80oCqgQ==", + "version": "4.4.0", + "resolved": "https://registry.npmjs.org/debug/-/debug-4.4.0.tgz", + "integrity": "sha512-6WTZ/IxCY/T6BALoZHaE4ctp9xm+Z5kY/pzYaCHRFeyVhojxlrm+46y68HA6hr0TcwEssoxNiDEUJQjfPZ/RYA==", "license": "MIT", "dependencies": { "ms": "^2.1.3" @@ -1107,9 +1104,9 @@ "license": "MIT" }, "node_modules/fast-xml-parser": { - "version": "4.5.0", - "resolved": "https://registry.npmjs.org/fast-xml-parser/-/fast-xml-parser-4.5.0.tgz", - "integrity": "sha512-/PlTQCI96+fZMAOLMZK4CWG1ItCbfZ/0jx7UIJFChPNrx7tcEgerUgWbeieCM9MfHInUDyK8DWYZ+YrywDJuTg==", + "version": "4.5.1", + "resolved": "https://registry.npmjs.org/fast-xml-parser/-/fast-xml-parser-4.5.1.tgz", + "integrity": "sha512-y655CeyUQ+jj7KBbYMc4FG01V8ZQqjN+gDYGJ50RtfsUB8iG9AmwmwoAgeKLJdmueKKMrH1RJ7yXHTSoczdv5w==", "funding": [ { "type": "github", @@ -1199,12 +1196,12 @@ } }, "node_modules/https-proxy-agent": { - "version": "7.0.5", - "resolved": "https://registry.npmjs.org/https-proxy-agent/-/https-proxy-agent-7.0.5.tgz", - "integrity": "sha512-1e4Wqeblerz+tMKPIq2EMGiiWW1dIjZOksyHWSUm1rmuvw/how9hBHZ38lAGj5ID4Ik6EdkOw7NmWPy6LAwalw==", + "version": "7.0.6", + "resolved": "https://registry.npmjs.org/https-proxy-agent/-/https-proxy-agent-7.0.6.tgz", + "integrity": "sha512-vK9P5/iUfdl95AI+JVyUuIcVtd4ofvtrOr3HNtM2yxC9bnMbEdp3x01OhQNnjb8IJYi38VlTE3mBXwcfvywuSw==", "license": "MIT", "dependencies": { - "agent-base": "^7.0.2", + "agent-base": "^7.1.2", "debug": "4" }, "engines": { @@ -1566,9 +1563,9 @@ "license": "MIT" }, "node_modules/readable-stream": { - "version": "4.5.2", - "resolved": "https://registry.npmjs.org/readable-stream/-/readable-stream-4.5.2.tgz", - "integrity": "sha512-yjavECdqeZ3GLXNgRXgeQEdz9fvDDkNKyHnbHRFtOr7/LcfgBcmct7t/ET+HaCTqfh06OzoAxrkN/IfjJBVe+g==", + "version": "4.7.0", + "resolved": "https://registry.npmjs.org/readable-stream/-/readable-stream-4.7.0.tgz", + "integrity": "sha512-oIGGmcpTLwPga8Bn6/Z75SVaH1z5dUut2ibSyAMVhmUggWpmDn2dapB0n7f8nwaSiRtepAsfJyfXIO5DCVAODg==", "license": "MIT", "dependencies": { "abort-controller": "^3.0.0", @@ -1656,9 +1653,9 @@ } }, "node_modules/streamx": { - "version": "2.20.2", - "resolved": "https://registry.npmjs.org/streamx/-/streamx-2.20.2.tgz", - "integrity": "sha512-aDGDLU+j9tJcUdPGOaHmVF1u/hhI+CsGkT02V3OKlHDV7IukOI+nTWAGkiZEKCO35rWN1wIr4tS7YFr1f4qSvA==", + "version": "2.21.1", + "resolved": "https://registry.npmjs.org/streamx/-/streamx-2.21.1.tgz", + "integrity": "sha512-PhP9wUnFLa+91CPy3N6tiQsK+gnYyUNuk15S3YG/zjYE7RuPeCjJngqnzpC31ow0lzBHQ+QGO4cNJnd0djYUsw==", "license": "MIT", "dependencies": { "fast-fifo": "^1.3.2", @@ -1792,10 +1789,13 @@ } }, "node_modules/text-decoder": { - "version": "1.2.1", - "resolved": "https://registry.npmjs.org/text-decoder/-/text-decoder-1.2.1.tgz", - "integrity": "sha512-x9v3H/lTKIJKQQe7RPQkLfKAnc9lUTkWDypIQgTzPJAq+5/GCDHonmshfvlsNSj58yyshbIJJDLmU15qNERrXQ==", - "license": "Apache-2.0" + "version": "1.2.3", + "resolved": "https://registry.npmjs.org/text-decoder/-/text-decoder-1.2.3.tgz", + "integrity": "sha512-3/o9z3X0X0fTupwsYvR03pJ/DjWuqqrfwBgTQzdWDiQSm9KitAyz/9WqsT2JQW7KV2m+bC2ol/zqpW37NHxLaA==", + "license": "Apache-2.0", + "dependencies": { + "b4a": "^1.6.4" + } }, "node_modules/tr46": { "version": "0.0.3", @@ -1880,9 +1880,9 @@ } }, "node_modules/undici": { - "version": "5.28.4", - "resolved": "https://registry.npmjs.org/undici/-/undici-5.28.4.tgz", - "integrity": "sha512-72RFADWFqKmUb2hmmvNODKL3p9hcB6Gt2DOQMis1SEBaV6a4MH8soBvzg+95CYhCKPFedut2JY9bMfrDl9D23g==", + "version": "5.28.5", + "resolved": "https://registry.npmjs.org/undici/-/undici-5.28.5.tgz", + "integrity": "sha512-zICwjrDrcrUE0pyyJc1I2QzBkLM8FINsgOrt6WjA+BgajVq9Nxu2PbFFXUrAggLfDXlZGZBVZYw7WNV5KiBiBA==", "license": "MIT", "dependencies": { "@fastify/busboy": "^2.0.0" diff --git a/node_modules/@actions/artifact/lib/internal/shared/config.js b/node_modules/@actions/artifact/lib/internal/shared/config.js index cef9109f..23666650 100644 --- a/node_modules/@actions/artifact/lib/internal/shared/config.js +++ b/node_modules/@actions/artifact/lib/internal/shared/config.js @@ -5,6 +5,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) { Object.defineProperty(exports, "__esModule", { value: true }); exports.getUploadChunkTimeout = exports.getConcurrency = exports.getGitHubWorkspaceDir = exports.isGhes = exports.getResultsServiceUrl = exports.getRuntimeToken = exports.getUploadChunkSize = void 0; const os_1 = __importDefault(require("os")); +const core_1 = require("@actions/core"); // Used for controlling the highWaterMark value of the zip that is being streamed // The same value is used as the chunk size that is use during upload to blob storage function getUploadChunkSize() { @@ -47,17 +48,38 @@ exports.getGitHubWorkspaceDir = getGitHubWorkspaceDir; // Mimics behavior of azcopy: https://learn.microsoft.com/en-us/azure/storage/common/storage-use-azcopy-optimize // If your machine has fewer than 5 CPUs, then the value of this variable is set to 32. // Otherwise, the default value is equal to 16 multiplied by the number of CPUs. The maximum value of this variable is 300. +// This value can be lowered with ACTIONS_ARTIFACT_UPLOAD_CONCURRENCY variable. function getConcurrency() { const numCPUs = os_1.default.cpus().length; - if (numCPUs <= 4) { - return 32; + let concurrencyCap = 32; + if (numCPUs > 4) { + const concurrency = 16 * numCPUs; + concurrencyCap = concurrency > 300 ? 300 : concurrency; } - const concurrency = 16 * numCPUs; - return concurrency > 300 ? 300 : concurrency; + const concurrencyOverride = process.env['ACTIONS_ARTIFACT_UPLOAD_CONCURRENCY']; + if (concurrencyOverride) { + const concurrency = parseInt(concurrencyOverride); + if (isNaN(concurrency) || concurrency < 1) { + throw new Error('Invalid value set for ACTIONS_ARTIFACT_UPLOAD_CONCURRENCY env variable'); + } + if (concurrency < concurrencyCap) { + return concurrency; + } + (0, core_1.info)(`ACTIONS_ARTIFACT_UPLOAD_CONCURRENCY is higher than the cap of ${concurrencyCap} based on the number of cpus. Lowering it to the cap.`); + } + return concurrencyCap; } exports.getConcurrency = getConcurrency; function getUploadChunkTimeout() { - return 300000; // 5 minutes + const timeoutVar = process.env['ACTIONS_ARTIFACT_UPLOAD_TIMEOUT_MS']; + if (!timeoutVar) { + return 300000; // 5 minutes + } + const timeout = parseInt(timeoutVar); + if (isNaN(timeout)) { + throw new Error('Invalid value set for ACTIONS_ARTIFACT_UPLOAD_TIMEOUT_MS env variable'); + } + return timeout; } exports.getUploadChunkTimeout = getUploadChunkTimeout; //# sourceMappingURL=config.js.map \ No newline at end of file diff --git a/node_modules/@actions/artifact/lib/internal/shared/config.js.map b/node_modules/@actions/artifact/lib/internal/shared/config.js.map index d5dbf456..60867fca 100644 --- a/node_modules/@actions/artifact/lib/internal/shared/config.js.map +++ b/node_modules/@actions/artifact/lib/internal/shared/config.js.map @@ -1 +1 @@ -{"version":3,"file":"config.js","sourceRoot":"","sources":["../../../src/internal/shared/config.ts"],"names":[],"mappings":";;;;;;AAAA,4CAAmB;AAEnB,iFAAiF;AACjF,qFAAqF;AACrF,SAAgB,kBAAkB;IAChC,OAAO,CAAC,GAAG,IAAI,GAAG,IAAI,CAAA,CAAC,cAAc;AACvC,CAAC;AAFD,gDAEC;AAED,SAAgB,eAAe;IAC7B,MAAM,KAAK,GAAG,OAAO,CAAC,GAAG,CAAC,uBAAuB,CAAC,CAAA;IAClD,IAAI,CAAC,KAAK,EAAE;QACV,MAAM,IAAI,KAAK,CAAC,sDAAsD,CAAC,CAAA;KACxE;IACD,OAAO,KAAK,CAAA;AACd,CAAC;AAND,0CAMC;AAED,SAAgB,oBAAoB;IAClC,MAAM,UAAU,GAAG,OAAO,CAAC,GAAG,CAAC,qBAAqB,CAAC,CAAA;IACrD,IAAI,CAAC,UAAU,EAAE;QACf,MAAM,IAAI,KAAK,CAAC,oDAAoD,CAAC,CAAA;KACtE;IAED,OAAO,IAAI,GAAG,CAAC,UAAU,CAAC,CAAC,MAAM,CAAA;AACnC,CAAC;AAPD,oDAOC;AAED,SAAgB,MAAM;IACpB,MAAM,KAAK,GAAG,IAAI,GAAG,CACnB,OAAO,CAAC,GAAG,CAAC,mBAAmB,CAAC,IAAI,oBAAoB,CACzD,CAAA;IAED,MAAM,QAAQ,GAAG,KAAK,CAAC,QAAQ,CAAC,OAAO,EAAE,CAAC,WAAW,EAAE,CAAA;IACvD,MAAM,YAAY,GAAG,QAAQ,KAAK,YAAY,CAAA;IAC9C,MAAM,SAAS,GAAG,QAAQ,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAA;IAC/C,MAAM,WAAW,GAAG,QAAQ,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAA;IAEnD,OAAO,CAAC,YAAY,IAAI,CAAC,SAAS,IAAI,CAAC,WAAW,CAAA;AACpD,CAAC;AAXD,wBAWC;AAED,SAAgB,qBAAqB;IACnC,MAAM,cAAc,GAAG,OAAO,CAAC,GAAG,CAAC,kBAAkB,CAAC,CAAA;IACtD,IAAI,CAAC,cAAc,EAAE;QACnB,MAAM,IAAI,KAAK,CAAC,iDAAiD,CAAC,CAAA;KACnE;IACD,OAAO,cAAc,CAAA;AACvB,CAAC;AAND,sDAMC;AAED,gHAAgH;AAChH,uFAAuF;AACvF,2HAA2H;AAC3H,SAAgB,cAAc;IAC5B,MAAM,OAAO,GAAG,YAAE,CAAC,IAAI,EAAE,CAAC,MAAM,CAAA;IAEhC,IAAI,OAAO,IAAI,CAAC,EAAE;QAChB,OAAO,EAAE,CAAA;KACV;IAED,MAAM,WAAW,GAAG,EAAE,GAAG,OAAO,CAAA;IAChC,OAAO,WAAW,GAAG,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,WAAW,CAAA;AAC9C,CAAC;AATD,wCASC;AAED,SAAgB,qBAAqB;IACnC,OAAO,MAAO,CAAA,CAAC,YAAY;AAC7B,CAAC;AAFD,sDAEC"} \ No newline at end of file +{"version":3,"file":"config.js","sourceRoot":"","sources":["../../../src/internal/shared/config.ts"],"names":[],"mappings":";;;;;;AAAA,4CAAmB;AACnB,wCAAkC;AAElC,iFAAiF;AACjF,qFAAqF;AACrF,SAAgB,kBAAkB;IAChC,OAAO,CAAC,GAAG,IAAI,GAAG,IAAI,CAAA,CAAC,cAAc;AACvC,CAAC;AAFD,gDAEC;AAED,SAAgB,eAAe;IAC7B,MAAM,KAAK,GAAG,OAAO,CAAC,GAAG,CAAC,uBAAuB,CAAC,CAAA;IAClD,IAAI,CAAC,KAAK,EAAE;QACV,MAAM,IAAI,KAAK,CAAC,sDAAsD,CAAC,CAAA;KACxE;IACD,OAAO,KAAK,CAAA;AACd,CAAC;AAND,0CAMC;AAED,SAAgB,oBAAoB;IAClC,MAAM,UAAU,GAAG,OAAO,CAAC,GAAG,CAAC,qBAAqB,CAAC,CAAA;IACrD,IAAI,CAAC,UAAU,EAAE;QACf,MAAM,IAAI,KAAK,CAAC,oDAAoD,CAAC,CAAA;KACtE;IAED,OAAO,IAAI,GAAG,CAAC,UAAU,CAAC,CAAC,MAAM,CAAA;AACnC,CAAC;AAPD,oDAOC;AAED,SAAgB,MAAM;IACpB,MAAM,KAAK,GAAG,IAAI,GAAG,CACnB,OAAO,CAAC,GAAG,CAAC,mBAAmB,CAAC,IAAI,oBAAoB,CACzD,CAAA;IAED,MAAM,QAAQ,GAAG,KAAK,CAAC,QAAQ,CAAC,OAAO,EAAE,CAAC,WAAW,EAAE,CAAA;IACvD,MAAM,YAAY,GAAG,QAAQ,KAAK,YAAY,CAAA;IAC9C,MAAM,SAAS,GAAG,QAAQ,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAA;IAC/C,MAAM,WAAW,GAAG,QAAQ,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAA;IAEnD,OAAO,CAAC,YAAY,IAAI,CAAC,SAAS,IAAI,CAAC,WAAW,CAAA;AACpD,CAAC;AAXD,wBAWC;AAED,SAAgB,qBAAqB;IACnC,MAAM,cAAc,GAAG,OAAO,CAAC,GAAG,CAAC,kBAAkB,CAAC,CAAA;IACtD,IAAI,CAAC,cAAc,EAAE;QACnB,MAAM,IAAI,KAAK,CAAC,iDAAiD,CAAC,CAAA;KACnE;IACD,OAAO,cAAc,CAAA;AACvB,CAAC;AAND,sDAMC;AAED,gHAAgH;AAChH,uFAAuF;AACvF,2HAA2H;AAC3H,+EAA+E;AAC/E,SAAgB,cAAc;IAC5B,MAAM,OAAO,GAAG,YAAE,CAAC,IAAI,EAAE,CAAC,MAAM,CAAA;IAChC,IAAI,cAAc,GAAG,EAAE,CAAA;IAEvB,IAAI,OAAO,GAAG,CAAC,EAAE;QACf,MAAM,WAAW,GAAG,EAAE,GAAG,OAAO,CAAA;QAChC,cAAc,GAAG,WAAW,GAAG,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,WAAW,CAAA;KACvD;IAED,MAAM,mBAAmB,GAAG,OAAO,CAAC,GAAG,CAAC,qCAAqC,CAAC,CAAA;IAC9E,IAAI,mBAAmB,EAAE;QACvB,MAAM,WAAW,GAAG,QAAQ,CAAC,mBAAmB,CAAC,CAAA;QACjD,IAAI,KAAK,CAAC,WAAW,CAAC,IAAI,WAAW,GAAG,CAAC,EAAE;YACzC,MAAM,IAAI,KAAK,CACb,wEAAwE,CACzE,CAAA;SACF;QAED,IAAI,WAAW,GAAG,cAAc,EAAE;YAChC,OAAO,WAAW,CAAA;SACnB;QAED,IAAA,WAAI,EACF,iEAAiE,cAAc,uDAAuD,CACvI,CAAA;KACF;IAED,OAAO,cAAc,CAAA;AACvB,CAAC;AA5BD,wCA4BC;AAED,SAAgB,qBAAqB;IACnC,MAAM,UAAU,GAAG,OAAO,CAAC,GAAG,CAAC,oCAAoC,CAAC,CAAA;IACpE,IAAI,CAAC,UAAU,EAAE;QACf,OAAO,MAAM,CAAA,CAAC,YAAY;KAC3B;IAED,MAAM,OAAO,GAAG,QAAQ,CAAC,UAAU,CAAC,CAAA;IACpC,IAAI,KAAK,CAAC,OAAO,CAAC,EAAE;QAClB,MAAM,IAAI,KAAK,CACb,uEAAuE,CACxE,CAAA;KACF;IAED,OAAO,OAAO,CAAA;AAChB,CAAC;AAdD,sDAcC"} \ No newline at end of file diff --git a/node_modules/@actions/artifact/lib/internal/shared/interfaces.d.ts b/node_modules/@actions/artifact/lib/internal/shared/interfaces.d.ts index a6461182..6f937b2a 100644 --- a/node_modules/@actions/artifact/lib/internal/shared/interfaces.d.ts +++ b/node_modules/@actions/artifact/lib/internal/shared/interfaces.d.ts @@ -11,6 +11,10 @@ export interface UploadArtifactResponse { * This ID can be used as input to other APIs to download, delete or get more information about an artifact: https://docs.github.com/en/rest/actions/artifacts */ id?: number; + /** + * The SHA256 digest of the artifact that was created. Not provided if no artifact was uploaded + */ + digest?: string; } /** * Options for uploading an artifact diff --git a/node_modules/@actions/artifact/lib/internal/upload/upload-artifact.js b/node_modules/@actions/artifact/lib/internal/upload/upload-artifact.js index 1aa3d3f8..151f7fbb 100644 --- a/node_modules/@actions/artifact/lib/internal/upload/upload-artifact.js +++ b/node_modules/@actions/artifact/lib/internal/upload/upload-artifact.js @@ -95,6 +95,7 @@ function uploadArtifact(name, files, rootDirectory, options) { core.info(`Artifact ${name}.zip successfully finalized. Artifact ID ${artifactId}`); return { size: uploadResult.uploadSize, + digest: uploadResult.sha256Hash, id: Number(artifactId) }; }); diff --git a/node_modules/@actions/artifact/lib/internal/upload/upload-artifact.js.map b/node_modules/@actions/artifact/lib/internal/upload/upload-artifact.js.map index d6e84f6f..352bb0fe 100644 --- a/node_modules/@actions/artifact/lib/internal/upload/upload-artifact.js.map +++ b/node_modules/@actions/artifact/lib/internal/upload/upload-artifact.js.map @@ -1 +1 @@ -{"version":3,"file":"upload-artifact.js","sourceRoot":"","sources":["../../../src/internal/upload/upload-artifact.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,oDAAqC;AAKrC,2CAAyC;AACzC,2FAAwE;AACxE,2EAA2E;AAC3E,yEAImC;AACnC,yCAAqD;AACrD,+CAAoD;AACpD,+BAA2C;AAC3C,+CAIwB;AACxB,6CAAyE;AAEzE,SAAsB,cAAc,CAClC,IAAY,EACZ,KAAe,EACf,aAAqB,EACrB,OAA2C;;QAE3C,IAAA,wDAAoB,EAAC,IAAI,CAAC,CAAA;QAC1B,IAAA,gDAAqB,EAAC,aAAa,CAAC,CAAA;QAEpC,MAAM,gBAAgB,GAA6B,IAAA,oDAAyB,EAC1E,KAAK,EACL,aAAa,CACd,CAAA;QACD,IAAI,gBAAgB,CAAC,MAAM,KAAK,CAAC,EAAE;YACjC,MAAM,IAAI,2BAAkB,CAC1B,gBAAgB,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CACpE,CAAA;SACF;QAED,+CAA+C;QAC/C,MAAM,UAAU,GAAG,IAAA,6BAAsB,GAAE,CAAA;QAE3C,6BAA6B;QAC7B,MAAM,cAAc,GAAG,IAAA,mDAA2B,GAAE,CAAA;QAEpD,sBAAsB;QACtB,MAAM,iBAAiB,GAA0B;YAC/C,oBAAoB,EAAE,UAAU,CAAC,oBAAoB;YACrD,uBAAuB,EAAE,UAAU,CAAC,uBAAuB;YAC3D,IAAI;YACJ,OAAO,EAAE,CAAC;SACX,CAAA;QAED,wDAAwD;QACxD,MAAM,SAAS,GAAG,IAAA,yBAAa,EAAC,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,aAAa,CAAC,CAAA;QACvD,IAAI,SAAS,EAAE;YACb,iBAAiB,CAAC,SAAS,GAAG,SAAS,CAAA;SACxC;QAED,MAAM,kBAAkB,GACtB,MAAM,cAAc,CAAC,cAAc,CAAC,iBAAiB,CAAC,CAAA;QACxD,IAAI,CAAC,kBAAkB,CAAC,EAAE,EAAE;YAC1B,MAAM,IAAI,6BAAoB,CAC5B,kDAAkD,CACnD,CAAA;SACF;QAED,MAAM,eAAe,GAAG,MAAM,IAAA,2BAAqB,EACjD,gBAAgB,EAChB,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,gBAAgB,CAC1B,CAAA;QAED,6BAA6B;QAC7B,MAAM,YAAY,GAAG,MAAM,IAAA,oCAAsB,EAC/C,kBAAkB,CAAC,eAAe,EAClC,eAAe,CAChB,CAAA;QAED,wBAAwB;QACxB,MAAM,mBAAmB,GAA4B;YACnD,oBAAoB,EAAE,UAAU,CAAC,oBAAoB;YACrD,uBAAuB,EAAE,UAAU,CAAC,uBAAuB;YAC3D,IAAI;YACJ,IAAI,EAAE,YAAY,CAAC,UAAU,CAAC,CAAC,CAAC,YAAY,CAAC,UAAU,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,GAAG;SACzE,CAAA;QAED,IAAI,YAAY,CAAC,UAAU,EAAE;YAC3B,mBAAmB,CAAC,IAAI,GAAG,uBAAW,CAAC,MAAM,CAAC;gBAC5C,KAAK,EAAE,UAAU,YAAY,CAAC,UAAU,EAAE;aAC3C,CAAC,CAAA;SACH;QAED,IAAI,CAAC,IAAI,CAAC,4BAA4B,CAAC,CAAA;QAEvC,MAAM,oBAAoB,GACxB,MAAM,cAAc,CAAC,gBAAgB,CAAC,mBAAmB,CAAC,CAAA;QAC5D,IAAI,CAAC,oBAAoB,CAAC,EAAE,EAAE;YAC5B,MAAM,IAAI,6BAAoB,CAC5B,oDAAoD,CACrD,CAAA;SACF;QAED,MAAM,UAAU,GAAG,MAAM,CAAC,oBAAoB,CAAC,UAAU,CAAC,CAAA;QAC1D,IAAI,CAAC,IAAI,CACP,YAAY,IAAI,4CAA4C,UAAU,EAAE,CACzE,CAAA;QAED,OAAO;YACL,IAAI,EAAE,YAAY,CAAC,UAAU;YAC7B,EAAE,EAAE,MAAM,CAAC,UAAU,CAAC;SACvB,CAAA;IACH,CAAC;CAAA;AA3FD,wCA2FC"} \ No newline at end of file +{"version":3,"file":"upload-artifact.js","sourceRoot":"","sources":["../../../src/internal/upload/upload-artifact.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,oDAAqC;AAKrC,2CAAyC;AACzC,2FAAwE;AACxE,2EAA2E;AAC3E,yEAImC;AACnC,yCAAqD;AACrD,+CAAoD;AACpD,+BAA2C;AAC3C,+CAIwB;AACxB,6CAAyE;AAEzE,SAAsB,cAAc,CAClC,IAAY,EACZ,KAAe,EACf,aAAqB,EACrB,OAA2C;;QAE3C,IAAA,wDAAoB,EAAC,IAAI,CAAC,CAAA;QAC1B,IAAA,gDAAqB,EAAC,aAAa,CAAC,CAAA;QAEpC,MAAM,gBAAgB,GAA6B,IAAA,oDAAyB,EAC1E,KAAK,EACL,aAAa,CACd,CAAA;QACD,IAAI,gBAAgB,CAAC,MAAM,KAAK,CAAC,EAAE;YACjC,MAAM,IAAI,2BAAkB,CAC1B,gBAAgB,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CACpE,CAAA;SACF;QAED,+CAA+C;QAC/C,MAAM,UAAU,GAAG,IAAA,6BAAsB,GAAE,CAAA;QAE3C,6BAA6B;QAC7B,MAAM,cAAc,GAAG,IAAA,mDAA2B,GAAE,CAAA;QAEpD,sBAAsB;QACtB,MAAM,iBAAiB,GAA0B;YAC/C,oBAAoB,EAAE,UAAU,CAAC,oBAAoB;YACrD,uBAAuB,EAAE,UAAU,CAAC,uBAAuB;YAC3D,IAAI;YACJ,OAAO,EAAE,CAAC;SACX,CAAA;QAED,wDAAwD;QACxD,MAAM,SAAS,GAAG,IAAA,yBAAa,EAAC,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,aAAa,CAAC,CAAA;QACvD,IAAI,SAAS,EAAE;YACb,iBAAiB,CAAC,SAAS,GAAG,SAAS,CAAA;SACxC;QAED,MAAM,kBAAkB,GACtB,MAAM,cAAc,CAAC,cAAc,CAAC,iBAAiB,CAAC,CAAA;QACxD,IAAI,CAAC,kBAAkB,CAAC,EAAE,EAAE;YAC1B,MAAM,IAAI,6BAAoB,CAC5B,kDAAkD,CACnD,CAAA;SACF;QAED,MAAM,eAAe,GAAG,MAAM,IAAA,2BAAqB,EACjD,gBAAgB,EAChB,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,gBAAgB,CAC1B,CAAA;QAED,6BAA6B;QAC7B,MAAM,YAAY,GAAG,MAAM,IAAA,oCAAsB,EAC/C,kBAAkB,CAAC,eAAe,EAClC,eAAe,CAChB,CAAA;QAED,wBAAwB;QACxB,MAAM,mBAAmB,GAA4B;YACnD,oBAAoB,EAAE,UAAU,CAAC,oBAAoB;YACrD,uBAAuB,EAAE,UAAU,CAAC,uBAAuB;YAC3D,IAAI;YACJ,IAAI,EAAE,YAAY,CAAC,UAAU,CAAC,CAAC,CAAC,YAAY,CAAC,UAAU,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,GAAG;SACzE,CAAA;QAED,IAAI,YAAY,CAAC,UAAU,EAAE;YAC3B,mBAAmB,CAAC,IAAI,GAAG,uBAAW,CAAC,MAAM,CAAC;gBAC5C,KAAK,EAAE,UAAU,YAAY,CAAC,UAAU,EAAE;aAC3C,CAAC,CAAA;SACH;QAED,IAAI,CAAC,IAAI,CAAC,4BAA4B,CAAC,CAAA;QAEvC,MAAM,oBAAoB,GACxB,MAAM,cAAc,CAAC,gBAAgB,CAAC,mBAAmB,CAAC,CAAA;QAC5D,IAAI,CAAC,oBAAoB,CAAC,EAAE,EAAE;YAC5B,MAAM,IAAI,6BAAoB,CAC5B,oDAAoD,CACrD,CAAA;SACF;QAED,MAAM,UAAU,GAAG,MAAM,CAAC,oBAAoB,CAAC,UAAU,CAAC,CAAA;QAC1D,IAAI,CAAC,IAAI,CACP,YAAY,IAAI,4CAA4C,UAAU,EAAE,CACzE,CAAA;QAED,OAAO;YACL,IAAI,EAAE,YAAY,CAAC,UAAU;YAC7B,MAAM,EAAE,YAAY,CAAC,UAAU;YAC/B,EAAE,EAAE,MAAM,CAAC,UAAU,CAAC;SACvB,CAAA;IACH,CAAC;CAAA;AA5FD,wCA4FC"} \ No newline at end of file diff --git a/node_modules/@actions/artifact/package.json b/node_modules/@actions/artifact/package.json index 3b3233a1..2200a758 100644 --- a/node_modules/@actions/artifact/package.json +++ b/node_modules/@actions/artifact/package.json @@ -1,6 +1,6 @@ { "name": "@actions/artifact", - "version": "2.1.11", + "version": "2.2.1", "preview": true, "description": "Actions artifact lib", "keywords": [ diff --git a/node_modules/@actions/github/node_modules/@octokit/openapi-types/package.json b/node_modules/@actions/github/node_modules/@octokit/openapi-types/package.json index 350a5825..9163156a 100644 --- a/node_modules/@actions/github/node_modules/@octokit/openapi-types/package.json +++ b/node_modules/@actions/github/node_modules/@octokit/openapi-types/package.json @@ -10,12 +10,12 @@ "access": "public", "provenance": true }, - "version": "22.2.0", + "version": "23.0.1", "main": "", "types": "types.d.ts", "author": "Gregor Martynus (https://twitter.com/gr2m)", "license": "MIT", "octokit": { - "openapi-version": "16.5.0" + "openapi-version": "17.1.1" } } diff --git a/node_modules/@actions/github/node_modules/@octokit/openapi-types/types.d.ts b/node_modules/@actions/github/node_modules/@octokit/openapi-types/types.d.ts index afa653c5..998a326d 100644 --- a/node_modules/@actions/github/node_modules/@octokit/openapi-types/types.d.ts +++ b/node_modules/@actions/github/node_modules/@octokit/openapi-types/types.d.ts @@ -138,8 +138,6 @@ export interface paths { * * 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. */ post: operations["apps/create-installation-access-token"]; @@ -163,7 +161,7 @@ export interface paths { "/applications/{client_id}/grant": { /** * 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. + * @description OAuth and GitHub application owners can revoke a grant for their application and a specific user. You must 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). */ delete: operations["apps/delete-authorization"]; @@ -171,17 +169,17 @@ export interface paths { "/applications/{client_id}/token": { /** * 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`. + * @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. Invalid tokens will return `404 NOT FOUND`. */ post: operations["apps/check-token"]; /** * 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. + * @description OAuth or GitHub application owners can revoke a single token for an OAuth application or a GitHub application with an OAuth authorization. */ delete: operations["apps/delete-token"]; /** * 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`. + * @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. Invalid tokens will return `404 NOT FOUND`. */ patch: operations["apps/reset-token"]; }; @@ -193,17 +191,14 @@ export interface paths { * 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. */ post: operations["apps/scope-token"]; }; "/apps/{app_slug}": { /** * 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`). + * @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"]; }; @@ -270,25 +265,104 @@ export interface paths { */ get: operations["emojis/get"]; }; - "/enterprises/{enterprise}/copilot/usage": { + "/enterprises/{enterprise}/code-security/configurations": { /** - * Get a summary of Copilot usage for enterprise members - * @description **Note**: This endpoint is in beta and is subject to change. + * Get code security configurations for an enterprise + * @description Lists all code security configurations available in an enterprise. * - * 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 authenticated user must be an administrator of the enterprise in order to use this endpoint. * - * 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. + * OAuth app tokens and personal access tokens (classic) need the `read:enterprise` scope to use this endpoint. + */ + get: operations["code-security/get-configurations-for-enterprise"]; + /** + * Create a code security configuration for an enterprise + * @description Creates a code security configuration in an 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. + */ + post: operations["code-security/create-configuration-for-enterprise"]; + }; + "/enterprises/{enterprise}/code-security/configurations/defaults": { + /** + * Get default code security configurations for an enterprise + * @description Lists the default code security configurations for an enterprise. * - * Only the owners and billing managers of enterprises with a Copilot Business or Enterprise subscription can view Copilot usage - * metrics for the 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 `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 `read:enterprise` scope to use this endpoint. */ - get: operations["copilot/usage-metrics-for-enterprise"]; + get: operations["code-security/get-default-configurations-for-enterprise"]; + }; + "/enterprises/{enterprise}/code-security/configurations/{configuration_id}": { + /** + * Retrieve a code security configuration of an enterprise + * @description Gets a code security configuration available in an 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 `read:enterprise` scope to use this endpoint. + */ + get: operations["code-security/get-single-configuration-for-enterprise"]; + /** + * Delete a code security configuration for an enterprise + * @description Deletes a code security configuration from an enterprise. + * Repositories attached to the configuration will retain their settings but will no longer be associated with + * the configuration. + * + * The authenticated user must be an administrator for the enterprise to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + */ + delete: operations["code-security/delete-configuration-for-enterprise"]; + /** + * Update a custom code security configuration for an enterprise + * @description Updates a code security configuration in an 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. + */ + patch: operations["code-security/update-enterprise-configuration"]; + }; + "/enterprises/{enterprise}/code-security/configurations/{configuration_id}/attach": { + /** + * Attach an enterprise configuration to repositories + * @description Attaches an enterprise code security configuration to repositories. If the repositories specified are already attached to a configuration, they will be re-attached to the provided configuration. + * + * If insufficient GHAS licenses are available to attach the configuration to a repository, only free features will be enabled. + * + * The authenticated user must be an administrator for the enterprise to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + */ + post: operations["code-security/attach-enterprise-configuration"]; + }; + "/enterprises/{enterprise}/code-security/configurations/{configuration_id}/defaults": { + /** + * Set a code security configuration as a default for an enterprise + * @description Sets a code security configuration as a default to be applied to new repositories in your enterprise. + * + * This configuration will be applied by default to the matching repository type when created, but only for organizations within the enterprise that do not already have a default code security configuration set. + * + * The authenticated user must be an administrator for the enterprise to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + */ + put: operations["code-security/set-configuration-as-default-for-enterprise"]; + }; + "/enterprises/{enterprise}/code-security/configurations/{configuration_id}/repositories": { + /** + * Get repositories associated with an enterprise code security configuration + * @description Lists the repositories associated with an enterprise code security configuration in an organization. + * + * 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 `read:enterprise` scope to use this endpoint. + */ + get: operations["code-security/get-repositories-for-enterprise-configuration"]; }; "/enterprises/{enterprise}/dependabot/alerts": { /** @@ -319,7 +393,8 @@ export interface paths { "/events": { /** * 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. + * @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-public-events"]; }; @@ -338,7 +413,8 @@ export interface paths { * * 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/authentication/authenticating-to-the-rest-api#using-basic-authentication) since current feed URIs use the older, non revocable auth tokens. */ get: operations["activity/get-feeds"]; }; @@ -352,7 +428,8 @@ export interface paths { * 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"]; }; @@ -511,10 +588,8 @@ export interface paths { * 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)." * @@ -555,7 +630,7 @@ export interface paths { * 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/authentication/authenticating-to-the-rest-api#using-basic-authentication) with their client ID and client secret to access this endpoint. */ get: operations["apps/get-subscription-plan-for-account"]; }; @@ -564,7 +639,7 @@ export interface paths { * 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/authentication/authenticating-to-the-rest-api#using-basic-authentication) with their client ID and client secret to access this endpoint. */ get: operations["apps/list-plans"]; }; @@ -573,7 +648,7 @@ export interface paths { * 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/authentication/authenticating-to-the-rest-api#using-basic-authentication) with their client ID and client secret to access this endpoint. */ get: operations["apps/list-accounts-for-plan"]; }; @@ -582,7 +657,7 @@ export interface paths { * 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/authentication/authenticating-to-the-rest-api#using-basic-authentication) with their client ID and client secret to access this endpoint. */ get: operations["apps/get-subscription-plan-for-account-stubbed"]; }; @@ -591,7 +666,7 @@ export interface paths { * 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/authentication/authenticating-to-the-rest-api#using-basic-authentication) with their client ID and client secret to access this endpoint. */ get: operations["apps/list-plans-stubbed"]; }; @@ -600,7 +675,7 @@ export interface paths { * 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/authentication/authenticating-to-the-rest-api#using-basic-authentication) with their client ID and client secret to access this endpoint. */ get: operations["apps/list-accounts-for-plan-stubbed"]; }; @@ -613,12 +688,17 @@ export interface paths { * * 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"]; }; "/networks/{owner}/{repo}/events": { - /** List public events for a network of repositories */ + /** + * List public events for a network of repositories + * @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-public-events-for-repo-network"]; }; "/notifications": { @@ -685,10 +765,20 @@ export interface paths { * 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"]; }; + "/organizations/{org}/settings/billing/usage": { + /** + * Get billing usage report for an organization + * @description Gets a report of the total usage for an organization. To use this endpoint, you must be an administrator of an organization within an enterprise or an organization account. + * + * **Note:** This endpoint is only available to organizations with access to the enhanced billing platform. For more information, see "[About the enhanced billing platform](https://docs.github.com/billing/using-the-new-billing-platform)." + */ + get: operations["billing/get-github-billing-usage-report-org"]; + }; "/orgs/{org}": { /** * Get an organization @@ -698,17 +788,6 @@ export interface paths { * * 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. @@ -727,20 +806,13 @@ export interface paths { delete: operations["orgs/delete"]; /** * 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: + * @description > [!WARNING] + * > **Closing down 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). * - * - 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 + * > [!WARNING] + * > **Closing down notice:** Code security product enablement for new repositories through the organization API is closing down. Please use [code security configurations](https://docs.github.com/rest/code-security/configurations#set-a-code-security-configuration-as-a-default-for-an-organization) to set defaults instead. For more information on setting a default security configuration, see the [changelog](https://github.blog/changelog/2024-07-09-sunsetting-security-settings-defaults-parameters-in-the-organizations-rest-api/). * - * 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)." + * Updates the organization's profile and member privileges. * * The authenticated user must be an organization owner to use this endpoint. * @@ -869,6 +941,109 @@ export interface paths { */ put: operations["actions/set-github-actions-default-workflow-permissions-organization"]; }; + "/orgs/{org}/actions/runner-groups": { + /** + * 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. + */ + get: operations["actions/list-self-hosted-runner-groups-for-org"]; + /** + * 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. + */ + post: operations["actions/create-self-hosted-runner-group-for-org"]; + }; + "/orgs/{org}/actions/runner-groups/{runner_group_id}": { + /** + * 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. + */ + get: operations["actions/get-self-hosted-runner-group-for-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. + */ + delete: operations["actions/delete-self-hosted-runner-group-from-org"]; + /** + * 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. + */ + patch: operations["actions/update-self-hosted-runner-group-for-org"]; + }; + "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories": { + /** + * 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. + */ + 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. + */ + put: operations["actions/set-repo-access-to-self-hosted-runner-group-in-org"]; + }; + "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories/{repository_id}": { + /** + * 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. + */ + put: operations["actions/add-repo-access-to-self-hosted-runner-group-in-org"]; + /** + * 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. + */ + delete: operations["actions/remove-repo-access-to-self-hosted-runner-group-in-org"]; + }; + "/orgs/{org}/actions/runner-groups/{runner_group_id}/runners": { + /** + * 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. + */ + 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. + */ + put: operations["actions/set-self-hosted-runners-in-group-for-org"]; + }; + "/orgs/{org}/actions/runner-groups/{runner_group_id}/runners/{runner_id}": { + /** + * 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. + */ + put: operations["actions/add-self-hosted-runner-to-group-for-org"]; + /** + * 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. + */ + delete: operations["actions/remove-self-hosted-runner-from-group-for-org"]; + }; "/orgs/{org}/actions/runners": { /** * List self-hosted runners for an organization @@ -1276,6 +1451,17 @@ export interface paths { */ delete: operations["actions/remove-selected-repo-from-org-variable"]; }; + "/orgs/{org}/attestations/{subject_digest}": { + /** + * List attestations + * @description List a collection of artifact attestations with a given subject digest that are associated with repositories owned by an organization. + * + * The collection of attestations returned by this endpoint is filtered according to the authenticated user's permissions; if the authenticated user cannot read a repository, the attestations associated with that repository will not be included in the response. In addition, when using a fine-grained access token the `attestations:read` permission is required. + * + * **Please note:** in order to offer meaningful security benefits, an attestation's signature and timestamps **must** be cryptographically verified, and the identity of the attestation signer **must** be validated. Attestations can be verified using the [GitHub CLI `attestation verify` command](https://cli.github.com/manual/gh_attestation_verify). For more information, see [our guide on how to use artifact attestations to establish a build's provenance](https://docs.github.com/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds). + */ + get: operations["orgs/list-attestations"]; + }; "/orgs/{org}/blocks": { /** * List users blocked by an organization @@ -1311,6 +1497,117 @@ export interface paths { */ get: operations["code-scanning/list-alerts-for-org"]; }; + "/orgs/{org}/code-security/configurations": { + /** + * Get code security configurations for an organization + * @description Lists all code security configurations available in an 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 `write:org` scope to use this endpoint. + */ + get: operations["code-security/get-configurations-for-org"]; + /** + * Create a code security configuration + * @description Creates a code security configuration in an 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 `write:org` scope to use this endpoint. + */ + post: operations["code-security/create-configuration"]; + }; + "/orgs/{org}/code-security/configurations/defaults": { + /** + * Get default code security configurations + * @description Lists the default code security configurations for an 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 `write:org` scope to use this endpoint. + */ + get: operations["code-security/get-default-configurations"]; + }; + "/orgs/{org}/code-security/configurations/detach": { + /** + * Detach configurations from repositories + * @description Detach code security configuration(s) from a set of repositories. + * Repositories will retain their settings but will no longer be associated with the configuration. + * + * 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 `write:org` scope to use this endpoint. + */ + delete: operations["code-security/detach-configuration"]; + }; + "/orgs/{org}/code-security/configurations/{configuration_id}": { + /** + * Get a code security configuration + * @description Gets a code security configuration available in an 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 `write:org` scope to use this endpoint. + */ + get: operations["code-security/get-configuration"]; + /** + * Delete a code security configuration + * @description Deletes the desired code security configuration from an organization. + * Repositories attached to the configuration will retain their settings but will no longer be associated with + * the configuration. + * + * 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 `write:org` scope to use this endpoint. + */ + delete: operations["code-security/delete-configuration"]; + /** + * Update a code security configuration + * @description Updates a code security configuration in an 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 `write:org` scope to use this endpoint. + */ + patch: operations["code-security/update-configuration"]; + }; + "/orgs/{org}/code-security/configurations/{configuration_id}/attach": { + /** + * Attach a configuration to repositories + * @description Attach a code security configuration to a set of repositories. If the repositories specified are already attached to a configuration, they will be re-attached to the provided configuration. + * + * If insufficient GHAS licenses are available to attach the configuration to a repository, only free features will be enabled. + * + * 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 `write:org` scope to use this endpoint. + */ + post: operations["code-security/attach-configuration"]; + }; + "/orgs/{org}/code-security/configurations/{configuration_id}/defaults": { + /** + * Set a code security configuration as a default for an organization + * @description Sets a code security configuration as a default to be applied to new repositories in your organization. + * + * This configuration will be applied to the matching repository type (all, none, public, private and internal) by default when they are created. + * + * 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 `write:org` scope to use this endpoint. + */ + put: operations["code-security/set-configuration-as-default"]; + }; + "/orgs/{org}/code-security/configurations/{configuration_id}/repositories": { + /** + * Get repositories associated with a code security configuration + * @description Lists the repositories associated with a code security configuration in an 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 `write:org` scope to use this endpoint. + */ + get: operations["code-security/get-repositories-for-configuration"]; + }; "/orgs/{org}/codespaces": { /** * List codespaces for the organization @@ -1434,116 +1731,141 @@ export interface paths { "/orgs/{org}/copilot/billing": { /** * Get Copilot seat information and settings for an organization - * @description **Note**: This endpoint is in beta and is subject to change. + * @description > [!NOTE] + * > This endpoint is in public preview 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)". + * and feature 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 view details about the organization's Copilot Business or Copilot 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 either the `manage_billing:copilot` or `read:org` scopes to use this endpoint. */ get: operations["copilot/get-copilot-organization-details"]; }; "/orgs/{org}/copilot/billing/seats": { /** * List all Copilot seat assignments for an organization - * @description **Note**: This endpoint is in beta and is subject to change. + * @description > [!NOTE] + * > This endpoint is in public preview 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 seats for which an organization with a Copilot Business or Copilot Enterprise subscription is currently being billed. + * Only organization owners can view assigned seats. * - * Only organization owners can configure and view details about the organization's Copilot Business or Enterprise subscription. + * Each seat object contains information about the assigned user's most recent Copilot activity. Users must have telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`. + * For more information about activity data, see "[Reviewing user activity data for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-user-activity-data-for-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 either the `manage_billing:copilot` or `read:org` scopes to use this endpoint. */ get: operations["copilot/list-copilot-seats"]; }; "/orgs/{org}/copilot/billing/selected_teams": { /** * Add teams to the Copilot subscription for an organization - * @description **Note**: This endpoint is in beta and is subject to change. + * @description > [!NOTE] + * > This endpoint is in public preview 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)". + * The organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see "[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization)." * - * Only organization owners can configure GitHub Copilot in their organization. + * Only organization owners can purchase Copilot seats for their organization members. The organization must have a Copilot Business or Copilot Enterprise subscription and a configured suggestion matching policy. + * For more information about setting up a Copilot subscription, see "[Subscribing to Copilot for your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/subscribing-to-copilot-for-your-organization)." + * For more information about setting a suggestion matching policy, see "[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching)." * - * 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)". + * The response contains the total number of new seats that were created and existing seats that were refreshed. * - * 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 either the `manage_billing:copilot` or `admin:org` scopes 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. + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. * - * 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)". + * Sets seats for all members of each team specified to "pending cancellation". + * This will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through another team. + * For more information about disabling access to Copilot, see "[Revoking access to Copilot for members of your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-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 cancel Copilot seats for their organization members. * - * Only organization owners can configure GitHub Copilot in their organization. + * The response contains the total number of seats set to "pending cancellation". * - * 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 either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. */ delete: operations["copilot/cancel-copilot-seat-assignment-for-teams"]; }; "/orgs/{org}/copilot/billing/selected_users": { /** * Add users to the Copilot subscription for an organization - * @description **Note**: This endpoint is in beta and is subject to change. + * @description > [!NOTE] + * > This endpoint is in public preview 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)". + * The organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see "[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization)." * - * Only organization owners can configure GitHub Copilot in their organization. + * Only organization owners can purchase Copilot seats for their organization members. The organization must have a Copilot Business or Copilot Enterprise subscription and a configured suggestion matching policy. + * For more information about setting up a Copilot subscription, see "[Subscribing to Copilot for your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/subscribing-to-copilot-for-your-organization)." + * For more information about setting a suggestion matching policy, see "[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching)." * - * 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)". + * The response contains the total number of new seats that were created and existing seats that were refreshed. * - * 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 either the `manage_billing:copilot` or `admin:org` scopes 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. + * @description > [!NOTE] + * > This endpoint is in public preview 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. + * Sets seats for all users specified to "pending cancellation". + * This will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through team membership. + * For more information about disabling access to Copilot, see "[Revoking access to Copilot for members of your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization)." * - * 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 cancel Copilot seats for their organization members. * - * 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)". + * The response contains the total number of seats set to "pending cancellation". * - * 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 either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. */ delete: operations["copilot/cancel-copilot-seat-assignment-for-users"]; }; + "/orgs/{org}/copilot/metrics": { + /** + * Get Copilot metrics for an organization + * @description Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions. + * + * > [!NOTE] + * > This endpoint will only return results for a given day if the organization contained **five or more members with active Copilot licenses** on that day, as evaluated at the end of that day. + * + * The response contains metrics for up to 28 days prior. 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. + * + * To access this endpoint, the Copilot Metrics API access policy must be enabled for the organization. + * Only organization owners and owners and billing managers of the parent enterprise can view Copilot metrics. + * + * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot`, `read:org`, or `read:enterprise` scopes to use this endpoint. + */ + get: operations["copilot/copilot-metrics-for-organization"]; + }; "/orgs/{org}/copilot/usage": { /** * Get a summary of Copilot usage for organization members - * @description **Note**: This endpoint is in beta and is subject to change. + * @description > [!NOTE] + * > This endpoint is in public preview 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, + * The response contains metrics for up to 28 days prior. 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. + * Organization owners, and owners and billing managers of the parent enterprise, 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 either the `manage_billing:copilot`, `read:org`, or `read:enterprise` scopes to use this endpoint. */ get: operations["copilot/usage-metrics-for-org"]; }; @@ -1722,7 +2044,11 @@ export interface paths { get: operations["packages/list-docker-migration-conflicting-packages-for-organization"]; }; "/orgs/{org}/events": { - /** List public organization events */ + /** + * List public organization 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-public-org-events"]; }; "/orgs/{org}/failed_invitations": { @@ -1735,7 +2061,9 @@ export interface paths { "/orgs/{org}/hooks": { /** * List organization webhooks - * @description You must be an organization owner to use this endpoint. + * @description List webhooks for an organization. + * + * The authenticated user 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. @@ -1766,7 +2094,9 @@ export interface paths { get: operations["orgs/get-webhook"]; /** * Delete an organization webhook - * @description You must be an organization owner to use this endpoint. + * @description Delete a webhook for an organization. + * + * The authenticated user 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. @@ -1858,6 +2188,69 @@ export interface paths { */ post: operations["orgs/ping-webhook"]; }; + "/orgs/{org}/insights/api/route-stats/{actor_type}/{actor_id}": { + /** + * Get route stats by actor + * @description Get API request count statistics for an actor broken down by route within a specified time frame. + */ + get: operations["api-insights/get-route-stats-by-actor"]; + }; + "/orgs/{org}/insights/api/subject-stats": { + /** + * Get subject stats + * @description Get API request statistics for all subjects within an organization within a specified time frame. Subjects can be users or GitHub Apps. + */ + get: operations["api-insights/get-subject-stats"]; + }; + "/orgs/{org}/insights/api/summary-stats": { + /** + * Get summary stats + * @description Get overall statistics of API requests made within an organization by all users and apps within a specified time frame. + */ + get: operations["api-insights/get-summary-stats"]; + }; + "/orgs/{org}/insights/api/summary-stats/users/{user_id}": { + /** + * Get summary stats by user + * @description Get overall statistics of API requests within the organization for a user. + */ + get: operations["api-insights/get-summary-stats-by-user"]; + }; + "/orgs/{org}/insights/api/summary-stats/{actor_type}/{actor_id}": { + /** + * Get summary stats by actor + * @description Get overall statistics of API requests within the organization made by a specific actor. Actors can be GitHub App installations, OAuth apps or other tokens on behalf of a user. + */ + get: operations["api-insights/get-summary-stats-by-actor"]; + }; + "/orgs/{org}/insights/api/time-stats": { + /** + * Get time stats + * @description Get the number of API requests and rate-limited requests made within an organization over a specified time period. + */ + get: operations["api-insights/get-time-stats"]; + }; + "/orgs/{org}/insights/api/time-stats/users/{user_id}": { + /** + * Get time stats by user + * @description Get the number of API requests and rate-limited requests made within an organization by a specific user over a specified time period. + */ + get: operations["api-insights/get-time-stats-by-user"]; + }; + "/orgs/{org}/insights/api/time-stats/{actor_type}/{actor_id}": { + /** + * Get time stats by actor + * @description Get the number of API requests and rate-limited requests made within an organization by a specific actor within a specified time period. + */ + get: operations["api-insights/get-time-stats-by-actor"]; + }; + "/orgs/{org}/insights/api/user-stats/{user_id}": { + /** + * Get user stats + * @description Get API usage statistics within an organization for a user broken down by the type of access. + */ + get: operations["api-insights/get-user-stats"]; + }; "/orgs/{org}/installation": { /** * Get an organization installation for the authenticated app @@ -1899,14 +2292,17 @@ export interface paths { "/orgs/{org}/invitations": { /** * 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`. + * @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"]; /** * 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)" + * 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/using-the-rest-api/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"]; @@ -1932,10 +2328,8 @@ export interface paths { * 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)." * @@ -1995,13 +2389,17 @@ export interface paths { "/orgs/{org}/members/{username}/copilot": { /** * Get Copilot seat assignment details for a user - * @description **Note**: This endpoint is in beta and is subject to change. + * @description > [!NOTE] + * > This endpoint is in public preview 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 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. + * The seat object contains information about the user's most recent Copilot activity. Users must have telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`. + * For more information about activity data, see "[Reviewing user activity data for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-user-activity-data-for-copilot-in-your-organization)." * - * OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. + * Only organization owners can view Copilot seat assignment details for members of their organization. + * + * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint. */ get: operations["copilot/get-copilot-seat-details-for-user"]; }; @@ -2021,7 +2419,7 @@ export interface paths { * * **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, organization owners are limited to creating 50 organization invitations for an organization within a 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"]; /** @@ -2086,26 +2484,10 @@ export interface paths { */ get: operations["migrations/list-repos-for-org"]; }; - "/orgs/{org}/organization-fine-grained-permissions": { - /** - * 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. - */ - get: operations["orgs/list-organization-fine-grained-permissions"]; - }; "/orgs/{org}/organization-roles": { /** * 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)." + * @description Lists the organization roles available in this organization. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." * * To use this endpoint, the authenticated user must be one of: * @@ -2115,23 +2497,11 @@ export interface paths { * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ get: operations["orgs/list-org-roles"]; - /** - * 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. - */ - post: operations["orgs/create-custom-organization-role"]; }; "/orgs/{org}/organization-roles/teams/{team_slug}": { /** * 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)." + * @description Removes all assigned organization roles from a team. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." * * The authenticated user must be an administrator for the organization to use this endpoint. * @@ -2142,7 +2512,7 @@ export interface paths { "/orgs/{org}/organization-roles/teams/{team_slug}/{role_id}": { /** * 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)." + * @description Assigns an organization role to a team in an organization. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." * * The authenticated user must be an administrator for the organization to use this endpoint. * @@ -2151,7 +2521,7 @@ export interface paths { put: operations["orgs/assign-team-to-org-role"]; /** * 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)." + * @description Removes an organization role from a team. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." * * The authenticated user must be an administrator for the organization to use this endpoint. * @@ -2162,7 +2532,7 @@ export interface paths { "/orgs/{org}/organization-roles/users/{username}": { /** * 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)." + * @description Revokes all assigned organization roles from a user. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." * * The authenticated user must be an administrator for the organization to use this endpoint. * @@ -2173,7 +2543,7 @@ export interface paths { "/orgs/{org}/organization-roles/users/{username}/{role_id}": { /** * 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)." + * @description Assigns an organization role to a member of an organization. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." * * The authenticated user must be an administrator for the organization to use this endpoint. * @@ -2182,7 +2552,7 @@ export interface paths { put: operations["orgs/assign-user-to-org-role"]; /** * 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)." + * @description Remove an organization role from a user. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." * * The authenticated user must be an administrator for the organization to use this endpoint. * @@ -2193,7 +2563,7 @@ export interface paths { "/orgs/{org}/organization-roles/{role_id}": { /** * 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)." + * @description Gets an organization role that is available to this organization. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." * * To use this endpoint, the authenticated user must be one of: * @@ -2203,36 +2573,11 @@ export interface paths { * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ get: operations["orgs/get-org-role"]; - /** - * 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. - */ - delete: operations["orgs/delete-custom-organization-role"]; - /** - * 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. - */ - patch: operations["orgs/patch-custom-organization-role"]; }; "/orgs/{org}/organization-roles/{role_id}/teams": { /** * 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)." + * @description Lists the teams that are assigned to an organization role. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." * * To use this endpoint, you must be an administrator for the organization. * @@ -2243,7 +2588,7 @@ export interface paths { "/orgs/{org}/organization-roles/{role_id}/users": { /** * 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)." + * @description Lists organization members that are assigned to an organization role. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." * * To use this endpoint, you must be an administrator for the organization. * @@ -2275,7 +2620,7 @@ export interface paths { * 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. For more information, 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"]; }; @@ -2284,7 +2629,7 @@ export interface paths { * 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. For more information, 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"]; /** @@ -2293,7 +2638,7 @@ export interface paths { * * 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. For more information, 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"]; }; @@ -2308,7 +2653,7 @@ export interface paths { * * 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. For more information, 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"]; }; @@ -2317,7 +2662,7 @@ export interface paths { * 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 `read:packages` scope to use this endpoint. For more information, 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"]; }; @@ -2326,7 +2671,7 @@ export interface paths { * 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. For more information, 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"]; /** @@ -2335,7 +2680,7 @@ export interface paths { * * 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. For more information, 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"]; }; @@ -2350,7 +2695,7 @@ export interface paths { * * 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. For more information, 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"]; }; @@ -2422,6 +2767,73 @@ export interface paths { */ get: operations["orgs/list-pat-grant-repositories"]; }; + "/orgs/{org}/private-registries": { + /** + * List private registries for an organization + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. + * + * Lists all private registry configurations 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. + */ + get: operations["private-registries/list-org-private-registries"]; + /** + * Create a private registry for an organization + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. + * + * Creates a private registry configuration with an encrypted value for an organization. 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. + */ + post: operations["private-registries/create-org-private-registry"]; + }; + "/orgs/{org}/private-registries/public-key": { + /** + * Get private registries public key for an organization + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. + * + * Gets the org public key, which is needed to encrypt private registry secrets. You need to encrypt a secret before you can create or update secrets. + * + * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + get: operations["private-registries/get-org-public-key"]; + }; + "/orgs/{org}/private-registries/{secret_name}": { + /** + * Get a private registry for an organization + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. + * + * Get the configuration of a single private registry defined for an organization, omitting its encrypted value. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + get: operations["private-registries/get-org-private-registry"]; + /** + * Delete a private registry for an organization + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. + * + * Delete a private registry configuration at the organization-level. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + delete: operations["private-registries/delete-org-private-registry"]; + /** + * Update a private registry for an organization + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. + * + * Updates a private registry configuration with an encrypted value for an organization. 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. + */ + patch: operations["private-registries/update-org-private-registry"]; + }; "/orgs/{org}/projects": { /** * List organization projects @@ -2530,7 +2942,8 @@ export interface paths { * 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"]; /** @@ -2573,6 +2986,9 @@ export interface paths { /** * Get an organization repository ruleset * @description Get a repository ruleset for an organization. + * + * **Note:** To prevent leaking sensitive information, the `bypass_actors` property is only returned if the user + * making the API request has write access to the ruleset. */ get: operations["repos/get-org-ruleset"]; /** @@ -2611,31 +3027,25 @@ export interface paths { "/orgs/{org}/security-managers": { /** * 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. + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** This operation is closing down and will be removed starting January 1, 2026. Please use the "[Organization Roles](https://docs.github.com/rest/orgs/organization-roles)" endpoints instead. */ get: operations["orgs/list-security-manager-teams"]; }; "/orgs/{org}/security-managers/teams/{team_slug}": { /** * 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. + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** This operation is closing down and will be removed starting January 1, 2026. Please use the "[Organization Roles](https://docs.github.com/rest/orgs/organization-roles)" endpoints instead. */ put: operations["orgs/add-security-manager-team"]; /** * 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. + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** This operation is closing down and will be removed starting January 1, 2026. Please use the "[Organization Roles](https://docs.github.com/rest/orgs/organization-roles)" endpoints instead. */ delete: operations["orgs/remove-security-manager-team"]; }; @@ -2672,25 +3082,45 @@ export interface paths { */ get: operations["billing/get-shared-storage-billing-org"]; }; + "/orgs/{org}/team/{team_slug}/copilot/metrics": { + /** + * Get Copilot metrics for a team + * @description Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions. + * + * > [!NOTE] + * > This endpoint will only return results for a given day if the team had **five or more members with active Copilot licenses** on that day, as evaluated at the end of that day. + * + * The response contains metrics for up to 28 days prior. 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. + * + * To access this endpoint, the Copilot Metrics API access policy must be enabled for the organization containing the team within GitHub settings. + * Only organization owners for the organization that contains this team and owners and billing managers of the parent enterprise can view Copilot metrics for a team. + * + * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot`, `read:org`, or `read:enterprise` scopes to use this endpoint. + */ + get: operations["copilot/copilot-metrics-for-team"]; + }; "/orgs/{org}/team/{team_slug}/copilot/usage": { /** * Get a summary of Copilot usage for a team - * @description **Note**: This endpoint is in beta and is subject to change. + * @description > [!NOTE] + * > This endpoint is in public preview 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, + * The response contains metrics for up to 28 days prior. 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 with active Copilot licenses, as evaluated at the end of 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. + * Organization owners for the organization that contains this team, and owners and billing managers of the parent enterprise 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 either the `manage_billing:copilot`, `read:org`, or `read:enterprise` scopes to use this endpoint. */ get: operations["copilot/usage-metrics-for-team"]; }; @@ -2713,7 +3143,8 @@ export interface paths { * 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"]; /** @@ -2722,14 +3153,16 @@ export interface paths { * * 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"]; /** * 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"]; }; @@ -2738,7 +3171,8 @@ export interface paths { * 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. */ @@ -2747,9 +3181,10 @@ export interface paths { * 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/using-the-rest-api/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. */ @@ -2760,7 +3195,8 @@ export interface paths { * 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. */ @@ -2769,7 +3205,8 @@ export interface paths { * 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. */ @@ -2778,7 +3215,8 @@ export interface paths { * 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. */ @@ -2789,7 +3227,8 @@ export interface paths { * 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. */ @@ -2798,9 +3237,10 @@ export interface paths { * 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/using-the-rest-api/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. */ @@ -2811,7 +3251,8 @@ export interface paths { * 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. */ @@ -2820,7 +3261,8 @@ export interface paths { * 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. */ @@ -2829,7 +3271,8 @@ export interface paths { * 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. */ @@ -2840,7 +3283,8 @@ export interface paths { * 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. */ @@ -2851,7 +3295,8 @@ export interface paths { * * 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. */ @@ -2860,7 +3305,8 @@ export interface paths { "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions/{reaction_id}": { /** * 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`. + * @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). * @@ -2873,7 +3319,8 @@ export interface paths { * 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. */ @@ -2884,7 +3331,8 @@ export interface paths { * * 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. */ @@ -2893,7 +3341,8 @@ export interface paths { "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions/{reaction_id}": { /** * 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`. + * @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). * @@ -2906,7 +3355,8 @@ export interface paths { * 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"]; }; @@ -2926,10 +3376,11 @@ export interface paths { * * 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). */ @@ -2940,13 +3391,15 @@ export interface paths { * * 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. * * 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"]; /** @@ -2955,9 +3408,11 @@ export interface paths { * * 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"]; }; @@ -2966,7 +3421,8 @@ export interface paths { * 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"]; }; @@ -2975,21 +3431,24 @@ export interface paths { * 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"]; /** * 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"]; }; @@ -2998,7 +3457,8 @@ export interface paths { * 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"]; }; @@ -3007,20 +3467,22 @@ export interface paths { * 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/using-the-rest-api/getting-started-with-the-rest-api#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}`. + * > [!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)". */ @@ -3029,7 +3491,8 @@ export interface paths { * 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"]; }; @@ -3038,18 +3501,23 @@ export interface paths { * 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"]; }; "/orgs/{org}/{security_product}/{enablement}": { /** * 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)." + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** The ability to enable or disable a security feature for all eligible repositories in an organization is closing down. Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. For more information, see the [changelog](https://github.blog/changelog/2024-07-22-deprecation-of-api-endpoint-to-enable-or-disable-a-security-feature-for-an-organization/). + * + * 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. + * OAuth app tokens and personal access tokens (classic) need the `admin:org`, `write:org`, or `repo` scopes to use this endpoint. */ post: operations["orgs/enable-or-disable-security-product-on-all-org-repos"]; }; @@ -3156,7 +3624,8 @@ export interface paths { "/rate_limit": { /** * Get rate limit status for the authenticated user - * @description **Note:** Accessing this endpoint does not count against your REST API rate limit. + * @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. @@ -3167,9 +3636,10 @@ export interface paths { * * 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)." + * * 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/about-the-rest-api/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 closing down. 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"]; }; @@ -3178,7 +3648,8 @@ export interface paths { * 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"]; /** @@ -3566,7 +4037,7 @@ export interface paths { * * 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 endpoint 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"]; }; @@ -3668,8 +4139,8 @@ export interface paths { * 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. */ @@ -3928,6 +4399,8 @@ export interface paths { * 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 endpoint 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"]; }; @@ -3972,6 +4445,28 @@ export interface paths { */ get: operations["issues/check-user-can-be-assigned"]; }; + "/repos/{owner}/{repo}/attestations": { + /** + * Create an attestation + * @description Store an artifact attestation and associate it with a repository. + * + * The authenticated user must have write permission to the repository and, if using a fine-grained access token, the `attestations:write` permission is required. + * + * Artifact attestations are meant to be created using the [attest action](https://github.com/actions/attest). For more information, see our guide on [using artifact attestations to establish a build's provenance](https://docs.github.com/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds). + */ + post: operations["repos/create-attestation"]; + }; + "/repos/{owner}/{repo}/attestations/{subject_digest}": { + /** + * List attestations + * @description List a collection of artifact attestations with a given subject digest that are associated with a repository. + * + * The authenticated user making the request must have read access to the repository. In addition, when using a fine-grained access token the `attestations:read` permission is required. + * + * **Please note:** in order to offer meaningful security benefits, an attestation's signature and timestamps **must** be cryptographically verified, and the identity of the attestation signer **must** be validated. Attestations can be verified using the [GitHub CLI `attestation verify` command](https://cli.github.com/manual/gh_attestation_verify). For more information, see [our guide on how to use artifact attestations to establish a build's provenance](https://docs.github.com/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds). + */ + get: operations["repos/list-attestations"]; + }; "/repos/{owner}/{repo}/autolinks": { /** * Get all autolinks of a repository @@ -4039,9 +4534,11 @@ export interface paths { * * 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"]; /** @@ -4088,7 +4585,8 @@ export interface paths { * * 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"]; }; @@ -4099,7 +4597,8 @@ export interface paths { * * 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"]; /** @@ -4165,7 +4664,8 @@ export interface paths { * * 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"]; /** @@ -4283,7 +4783,8 @@ export interface paths { * 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. * @@ -4307,7 +4808,8 @@ export interface paths { * 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. */ @@ -4316,7 +4818,8 @@ export interface paths { * 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. */ @@ -4347,7 +4850,8 @@ export interface paths { * 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. */ @@ -4366,7 +4870,8 @@ export interface paths { * 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. */ @@ -4377,7 +4882,8 @@ export interface paths { * 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. */ @@ -4423,6 +4929,37 @@ export interface paths { */ patch: operations["code-scanning/update-alert"]; }; + "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/autofix": { + /** + * Get the status of an autofix for a code scanning alert + * @description Gets the status and description of an autofix for a 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. + */ + get: operations["code-scanning/get-autofix"]; + /** + * Create an autofix for a code scanning alert + * @description Creates an autofix for a code scanning alert. + * + * If a new autofix is to be created as a result of this request or is currently being generated, then this endpoint will return a 202 Accepted response. + * + * If an autofix already exists for a given alert, then this endpoint will return a 200 OK response. + * + * 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/create-autofix"]; + }; + "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/autofix/commits": { + /** + * Commit an autofix for a code scanning alert + * @description Commits an autofix for a code scanning alert. + * + * If an autofix is commited as a result of this request, then this endpoint will return a 201 Created response. + * + * 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. + */ + post: operations["code-scanning/commit-autofix"]; + }; "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/instances": { /** * List instances of a code scanning alert @@ -4446,8 +4983,8 @@ export interface paths { * 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. + * > [!WARNING] + * > **Closing down notice:** The `tool_name` field is closing down 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. */ @@ -4549,7 +5086,7 @@ export interface paths { * 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 `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/list-codeql-databases"]; }; @@ -4560,13 +5097,52 @@ export interface paths { * * 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 + * to [`application/zip`](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#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 `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-codeql-database"]; + /** + * Delete a CodeQL database + * @description Deletes a CodeQL database for a language in a repository. + * + * 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-codeql-database"]; + }; + "/repos/{owner}/{repo}/code-scanning/codeql/variant-analyses": { + /** + * Create a CodeQL variant analysis + * @description Creates a new CodeQL variant analysis, which will run a CodeQL query against one or more repositories. + * + * Get started by learning more about [running CodeQL queries at scale with Multi-Repository Variant Analysis](https://docs.github.com/code-security/codeql-for-vs-code/getting-started-with-codeql-for-vs-code/running-codeql-queries-at-scale-with-multi-repository-variant-analysis). + * + * Use the `owner` and `repo` parameters in the URL to specify the controller repository that + * will be used for running GitHub Actions workflows and storing the results of the CodeQL variant analysis. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + post: operations["code-scanning/create-variant-analysis"]; + }; + "/repos/{owner}/{repo}/code-scanning/codeql/variant-analyses/{codeql_variant_analysis_id}": { + /** + * Get the summary of a CodeQL variant analysis + * @description Gets the summary of a CodeQL variant analysis. + * + * 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-variant-analysis"]; + }; + "/repos/{owner}/{repo}/code-scanning/codeql/variant-analyses/{codeql_variant_analysis_id}/repos/{repo_owner}/{repo_name}": { + /** + * Get the analysis status of a repository in a CodeQL variant analysis + * @description Gets the analysis status of a repository in a CodeQL variant analysis. + * + * 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-variant-analysis-repo-task"]; }; "/repos/{owner}/{repo}/code-scanning/default-setup": { /** @@ -4619,6 +5195,8 @@ export interface paths { * 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. + * + * This endpoint is limited to 1,000 requests per hour for each user or app installation calling it. */ post: operations["code-scanning/upload-sarif"]; }; @@ -4630,6 +5208,17 @@ export interface paths { */ get: operations["code-scanning/get-sarif"]; }; + "/repos/{owner}/{repo}/code-security-configuration": { + /** + * Get the code security configuration associated with a repository + * @description Get the code security configuration that manages a repository's code security settings. + * + * 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` scope to use this endpoint. + */ + get: operations["code-security/get-configuration-for-repository"]; + }; "/repos/{owner}/{repo}/codeowners/errors": { /** * List CODEOWNERS errors @@ -4710,8 +5299,6 @@ export interface paths { * @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. */ get: operations["codespaces/get-repo-public-key"]; @@ -4768,7 +5355,7 @@ export interface paths { 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)." + * @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/using-the-rest-api/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)." * @@ -4809,7 +5396,8 @@ export interface paths { * - 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. * @@ -4887,7 +5475,8 @@ export interface paths { "/repos/{owner}/{repo}/comments/{comment_id}/reactions/{reaction_id}": { /** * 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`. + * @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). */ @@ -4906,6 +5495,7 @@ export interface paths { * | `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. | + * | `verified_at` | `string` | The date the signature was verified by GitHub. | * * These are the possible values for `reason` in the `verification` object: * @@ -4953,7 +5543,7 @@ export interface paths { * 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/using-the-rest-api/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)." * @@ -4978,7 +5568,8 @@ export interface paths { * 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. * @@ -4996,6 +5587,7 @@ export interface paths { * | `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. | + * | `verified_at` | `string` | The date the signature was verified by GitHub. | * * These are the possible values for `reason` in the `verification` object: * @@ -5022,7 +5614,8 @@ export interface paths { * 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. * @@ -5035,7 +5628,8 @@ export interface paths { * 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. */ @@ -5101,7 +5695,7 @@ export interface paths { * * 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 list of changed files is only shown on the first page of results, and it includes up to 300 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)." @@ -5116,6 +5710,7 @@ export interface paths { * | `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. | + * | `verified_at` | `string` | The date the signature was verified by GitHub. | * * These are the possible values for `reason` in the `verification` object: * @@ -5171,7 +5766,8 @@ export interface paths { * 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. */ @@ -5186,7 +5782,8 @@ export interface paths { * * 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"]; }; @@ -5415,7 +6012,8 @@ export interface paths { "/repos/{owner}/{repo}/environments/{environment_name}": { /** * 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)." + * @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. * @@ -5426,9 +6024,11 @@ export interface paths { * 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. */ @@ -5507,7 +6107,9 @@ export interface paths { "/repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules/apps": { /** * 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. + * @description Gets all custom deployment protection rule integrations that are available for an environment. + * + * The authenticated user must have admin or owner permissions to the repository to 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)." * @@ -5643,7 +6245,8 @@ export interface paths { "/repos/{owner}/{repo}/events": { /** * 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. + * @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"]; }; @@ -5654,9 +6257,11 @@ export interface paths { * 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"]; }; @@ -5693,6 +6298,7 @@ export interface paths { * | `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. | + * | `verified_at` | `string` | The date the signature was verified by GitHub. | * * These are the possible values for `reason` in the `verification` object: * @@ -5731,6 +6337,7 @@ export interface paths { * | `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. | + * | `verified_at` | `string` | The date the signature was verified by GitHub. | * * These are the possible values for `reason` in the `verification` object: * @@ -5759,7 +6366,8 @@ export interface paths { * * 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`. */ @@ -5770,7 +6378,8 @@ export interface paths { * 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"]; }; @@ -5808,6 +6417,7 @@ export interface paths { * | `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. | + * | `verified_at` | `string` | The date the signature was verified by GitHub. | * * These are the possible values for `reason` in the `verification` object: * @@ -5842,6 +6452,7 @@ export interface paths { * | `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. | + * | `verified_at` | `string` | The date the signature was verified by GitHub. | * * These are the possible values for `reason` in the `verification` object: * @@ -5881,8 +6492,8 @@ export interface paths { * * 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"]; }; @@ -5905,7 +6516,12 @@ export interface paths { * @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"]; - /** Delete a repository webhook */ + /** + * Delete a repository webhook + * @description Delete a webhook for an organization. + * + * The authenticated user must be a repository owner, or have admin access in the repository, to delete the webhook. + */ delete: operations["repos/delete-webhook"]; /** * Update a repository webhook @@ -5962,7 +6578,8 @@ export interface paths { * 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"]; }; @@ -5972,7 +6589,8 @@ export interface paths { * @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] + * > **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down 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** * @@ -6015,7 +6633,8 @@ export interface paths { * 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] + * > **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down 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"]; /** @@ -6023,7 +6642,8 @@ export interface paths { * @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] + * > **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down 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"]; /** @@ -6036,7 +6656,8 @@ export interface paths { * 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] + * > **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down 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"]; }; @@ -6048,7 +6669,8 @@ export interface paths { * * 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] + * > **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down 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"]; }; @@ -6059,7 +6681,8 @@ export interface paths { * @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). + * > [!WARNING] + * > **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down 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"]; }; @@ -6069,7 +6692,8 @@ export interface paths { * @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] + * > **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down 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"]; }; @@ -6083,7 +6707,8 @@ export interface paths { * 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] + * > **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down 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"]; }; @@ -6131,10 +6756,8 @@ export interface paths { * 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)." * @@ -6148,7 +6771,7 @@ export interface paths { * 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)" + * 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/using-the-rest-api/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)." @@ -6222,7 +6845,8 @@ export interface paths { "/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions/{reaction_id}": { /** * 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`. + * @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). */ @@ -6252,10 +6876,8 @@ export interface paths { * 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)." * @@ -6267,7 +6889,7 @@ export interface paths { get: operations["issues/get"]; /** * Update an issue - * @description Issue owners and users with push access can edit an issue. + * @description Issue owners and users with push access or Triage role 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)." * @@ -6322,7 +6944,7 @@ export interface paths { * * 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)" + * For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/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)." @@ -6399,12 +7021,65 @@ export interface paths { "/repos/{owner}/{repo}/issues/{issue_number}/reactions/{reaction_id}": { /** * 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`. + * @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: operations["reactions/delete-for-issue"]; }; + "/repos/{owner}/{repo}/issues/{issue_number}/sub_issue": { + /** + * Remove sub-issue + * @description You can use the REST API to remove a sub-issue from an issue. + * Removing 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/using-the-rest-api/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 a specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + */ + delete: operations["issues/remove-sub-issue"]; + }; + "/repos/{owner}/{repo}/issues/{issue_number}/sub_issues": { + /** + * List sub-issues + * @description You can use the REST API to list the sub-issues on 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`. + */ + get: operations["issues/list-sub-issues"]; + /** + * Add sub-issue + * @description You can use the REST API to add sub-issues to issues. + * + * 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/using-the-rest-api/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`. + */ + post: operations["issues/add-sub-issue"]; + }; + "/repos/{owner}/{repo}/issues/{issue_number}/sub_issues/priority": { + /** + * Reprioritize sub-issue + * @description You can use the REST API to reprioritize a sub-issue to a different position in the parent list. + */ + patch: operations["issues/reprioritize-sub-issue"]; + }; "/repos/{owner}/{repo}/issues/{issue_number}/timeline": { /** * List timeline events for an issue @@ -6714,7 +7389,7 @@ export interface paths { * * 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/using-the-rest-api/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)." * @@ -6786,7 +7461,8 @@ export interface paths { "/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions/{reaction_id}": { /** * 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.` + * @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). */ @@ -6809,7 +7485,7 @@ export interface paths { * * 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/using-the-rest-api/getting-started-with-the-rest-api#media-types) 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)." * @@ -6864,9 +7540,9 @@ export interface paths { * * 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 closing down. 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)" + * 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/using-the-rest-api/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)." @@ -6883,7 +7559,7 @@ export interface paths { * 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)" + * 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/using-the-rest-api/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)." @@ -6916,8 +7592,8 @@ export interface paths { * 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)." * @@ -6937,7 +7613,7 @@ 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/using-the-rest-api/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"]; }; @@ -6975,11 +7651,12 @@ export interface paths { * 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/using-the-rest-api/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. + * > [!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. * @@ -7049,9 +7726,8 @@ export interface paths { * 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)." * @@ -7080,6 +7756,7 @@ export interface paths { /** * 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. + * Note: If making a request on behalf of a GitHub App you must also have permissions to write the contents of the head repository. */ put: operations["pulls/update-branch"]; }; @@ -7119,14 +7796,20 @@ export interface paths { * 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/using-the-rest-api/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"]; }; "/repos/{owner}/{repo}/releases/assets/{asset_id}": { /** * 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. + * @description To download the asset's binary content: + * + * - If within a browser, fetch the location specified in the `browser_download_url` key provided in the response. + * - Alternatively, set the `Accept` header of the request to + * [`application/octet-stream`](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#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"]; /** Delete a release asset */ @@ -7165,9 +7848,8 @@ export interface paths { * 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"]; /** @@ -7223,7 +7905,8 @@ export interface paths { "/repos/{owner}/{repo}/releases/{release_id}/reactions/{reaction_id}": { /** * 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`. + * @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). */ @@ -7271,6 +7954,9 @@ export interface paths { /** * Get a repository ruleset * @description Get a ruleset for a repository. + * + * **Note:** To prevent leaking sensitive information, the `bypass_actors` property is only returned if the user + * making the API request has write access to the ruleset. */ get: operations["repos/get-repo-ruleset"]; /** @@ -7326,6 +8012,26 @@ export interface paths { */ get: operations["secret-scanning/list-locations-for-alert"]; }; + "/repos/{owner}/{repo}/secret-scanning/push-protection-bypasses": { + /** + * Create a push protection bypass + * @description Creates a bypass for a previously push protected secret. + * + * The authenticated user must be the original author of the committed secret. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + post: operations["secret-scanning/create-push-protection-bypass"]; + }; + "/repos/{owner}/{repo}/secret-scanning/scan-history": { + /** + * Get secret scanning scan history for a repository + * @description Lists the latest default incremental and backfill scans by type for a repository. Scans from Copilot Secret Scanning are not included. + * + * 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-scan-history"]; + }; "/repos/{owner}/{repo}/security-advisories": { /** * List repository security advisories @@ -7396,7 +8102,8 @@ export interface paths { * 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"]; }; @@ -7414,11 +8121,10 @@ export interface paths { "/repos/{owner}/{repo}/stats/code_frequency": { /** * Get the weekly commit activity - * @description - * Returns a weekly aggregate of the number of additions and deletions pushed to a repository. + * @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. + * > [!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"]; }; @@ -7440,7 +8146,8 @@ export interface paths { * * `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"]; }; @@ -7507,23 +8214,35 @@ export interface paths { }; "/repos/{owner}/{repo}/tags/protection": { /** - * List tag protection states for a repository - * @description This returns the tag protection states of a repository. + * Closing down - List tag protection states for a repository + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** This operation is closing down and will be removed after August 30, 2024. Use the "[Repository Rulesets](https://docs.github.com/rest/repos/rules#get-all-repository-rulesets)" endpoint instead. + * + * This returns the tag protection states of a repository. * * This information is only available to repository administrators. */ get: operations["repos/list-tag-protection"]; /** - * Create a tag protection state for a repository - * @description This creates a tag protection state for a repository. + * Closing down - Create a tag protection state for a repository + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** This operation is closing down and will be removed after August 30, 2024. Use the "[Repository Rulesets](https://docs.github.com/rest/repos/rules#create-a-repository-ruleset)" endpoint instead. + * + * This creates a tag protection state for a repository. * This endpoint is only available to repository administrators. */ post: operations["repos/create-tag-protection"]; }; "/repos/{owner}/{repo}/tags/protection/{tag_protection_id}": { /** - * Delete a tag protection state for a repository - * @description This deletes a tag protection state for a repository. + * Closing down - Delete a tag protection state for a repository + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** This operation is closing down and will be removed after August 30, 2024. Use the "[Repository Rulesets](https://docs.github.com/rest/repos/rules#delete-a-repository-ruleset)" endpoint instead. + * + * This deletes a tag protection state for a repository. * This endpoint is only available to repository administrators. */ delete: operations["repos/delete-tag-protection"]; @@ -7534,7 +8253,9 @@ export interface paths { * @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. + * + * > [!NOTE] + * > For private repositories, these links are temporary and expire after five minutes. */ get: operations["repos/download-tarball-archive"]; }; @@ -7616,7 +8337,8 @@ export interface paths { * `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"]; }; @@ -7694,7 +8416,8 @@ export interface paths { * * 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"]; }; @@ -7764,13 +8487,15 @@ export interface paths { /** * 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. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down 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"]; /** * 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. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down 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. * @@ -7780,11 +8505,13 @@ export interface paths { /** * 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. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down 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`. + * > [!NOTE] + * > With nested teams, the `privacy` for parent teams cannot be `secret`. */ patch: operations["teams/update-legacy"]; }; @@ -7792,7 +8519,8 @@ export interface paths { /** * 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. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down 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. * @@ -7802,11 +8530,12 @@ export interface paths { /** * 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. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down 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)." + * 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/using-the-rest-api/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. */ @@ -7816,7 +8545,8 @@ export interface paths { /** * 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. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down 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. * @@ -7826,7 +8556,8 @@ export interface paths { /** * 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. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down 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. * @@ -7836,7 +8567,8 @@ export interface paths { /** * 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. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down 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. * @@ -7848,7 +8580,8 @@ export interface paths { /** * 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. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down 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. * @@ -7858,11 +8591,12 @@ export interface paths { /** * 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. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down 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)." + * 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/using-the-rest-api/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. */ @@ -7872,7 +8606,8 @@ export interface paths { /** * 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. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down 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. * @@ -7882,7 +8617,8 @@ export interface paths { /** * 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. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down 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. * @@ -7892,7 +8628,8 @@ export interface paths { /** * 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. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down 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. * @@ -7904,7 +8641,8 @@ export interface paths { /** * 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. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down 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). * @@ -7914,7 +8652,8 @@ export interface paths { /** * 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. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down 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). * @@ -7928,7 +8667,8 @@ export interface paths { /** * 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. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down 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). * @@ -7938,7 +8678,8 @@ export interface paths { /** * 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. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down 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). * @@ -7952,7 +8693,8 @@ export interface paths { /** * 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. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down 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`. */ @@ -7962,7 +8704,8 @@ export interface paths { /** * 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. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down 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. */ @@ -7972,7 +8715,7 @@ export interface paths { /** * Get team member (Legacy) * @deprecated - * @description The "Get team member" endpoint (described below) is deprecated. + * @description The "Get team member" endpoint (described below) is closing down. * * 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. * @@ -7982,7 +8725,7 @@ export interface paths { /** * Add team member (Legacy) * @deprecated - * @description The "Add team member" endpoint (described below) is deprecated. + * @description The "Add team member" endpoint (described below) is closing down. * * 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. * @@ -7990,7 +8733,8 @@ export interface paths { * * 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)." */ @@ -7998,7 +8742,7 @@ export interface paths { /** * Remove team member (Legacy) * @deprecated - * @description The "Remove team member" endpoint (described below) is deprecated. + * @description The "Remove team member" endpoint (described below) is closing down. * * 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. * @@ -8006,7 +8750,8 @@ export interface paths { * * 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"]; }; @@ -8014,7 +8759,8 @@ export interface paths { /** * 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. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down 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. * @@ -8029,13 +8775,15 @@ export interface paths { /** * 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. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down 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/)." + * > [!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. * @@ -8045,13 +8793,15 @@ export interface paths { /** * 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. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down 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/)." + * > [!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"]; }; @@ -8059,7 +8809,8 @@ export interface paths { /** * 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. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down 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. */ @@ -8069,7 +8820,8 @@ export interface paths { /** * 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. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down 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. */ @@ -8077,7 +8829,8 @@ export interface paths { /** * 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. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down 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. */ @@ -8085,7 +8838,8 @@ export interface paths { /** * 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. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down 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. */ @@ -8095,7 +8849,8 @@ export interface paths { /** * 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. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down 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"]; }; @@ -8103,17 +8858,20 @@ export interface paths { /** * Check team permissions for a repository (Legacy) * @deprecated - * @description **Note**: Repositories inherited through a parent team will also be checked. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down 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. + * > [!NOTE] + * > 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 `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/using-the-rest-api/getting-started-with-the-rest-api#media-types/) via the `Accept` header: */ get: operations["teams/check-permissions-for-repo-legacy"]; /** * 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. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down 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. * @@ -8123,7 +8881,8 @@ export interface paths { /** * 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. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down 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. */ @@ -8133,7 +8892,8 @@ export interface paths { /** * 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. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down 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"]; }; @@ -8493,11 +9253,15 @@ export interface paths { /** * 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. + * + * This endpoint only works for PATs (classic) with the `repo` scope. */ put: operations["apps/add-repo-to-installation-for-authenticated-user"]; /** * 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`. + * + * This endpoint only works for PATs (classic) with the `repo` scope. */ delete: operations["apps/remove-repo-from-installation-for-authenticated-user"]; }; @@ -8523,10 +9287,8 @@ export interface paths { * 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)." * @@ -8680,6 +9442,9 @@ export interface paths { * @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. + * + * > [!NOTE] + * > Requests using a fine-grained access token will receive a `200 Success` response with an empty list. */ get: operations["orgs/list-for-authenticated-user"]; }; @@ -8688,7 +9453,7 @@ export interface paths { * 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. For more information, 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"]; }; @@ -8697,14 +9462,14 @@ export interface paths { * 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. For more information, 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"]; /** * 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. For more information, 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"]; }; @@ -8717,7 +9482,7 @@ export interface paths { * - 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. For more information, 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"]; }; @@ -8726,7 +9491,7 @@ export interface paths { * 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. For more information, 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"]; }; @@ -8735,7 +9500,7 @@ export interface paths { * 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. For more information, 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"]; /** @@ -8744,7 +9509,7 @@ export interface paths { * * 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. For more information, 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"]; }; @@ -8757,7 +9522,7 @@ export interface paths { * - 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. For more information, 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"]; }; @@ -8908,6 +9673,17 @@ export interface paths { */ get: operations["teams/list-for-authenticated-user"]; }; + "/user/{account_id}": { + /** + * Get a user using their ID + * @description Provides publicly available information about someone with a GitHub account. This method takes their durable user `ID` instead of their `login`, which can change over time. + * + * 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)". + */ + get: operations["users/get-by-id"]; + }; "/users": { /** * List users @@ -8928,6 +9704,17 @@ export interface paths { */ get: operations["users/get-by-username"]; }; + "/users/{username}/attestations/{subject_digest}": { + /** + * List attestations + * @description List a collection of artifact attestations with a given subject digest that are associated with repositories owned by a user. + * + * The collection of attestations returned by this endpoint is filtered according to the authenticated user's permissions; if the authenticated user cannot read a repository, the attestations associated with that repository will not be included in the response. In addition, when using a fine-grained access token the `attestations:read` permission is required. + * + * **Please note:** in order to offer meaningful security benefits, an attestation's signature and timestamps **must** be cryptographically verified, and the identity of the attestation signer **must** be validated. Attestations can be verified using the [GitHub CLI `attestation verify` command](https://cli.github.com/manual/gh_attestation_verify). For more information, see [our guide on how to use artifact attestations to establish a build's provenance](https://docs.github.com/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds). + */ + get: operations["users/list-attestations"]; + }; "/users/{username}/docker/conflicts": { /** * Get list of conflicting packages during Docker migration for user @@ -8940,7 +9727,10 @@ export interface paths { "/users/{username}/events": { /** * 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. + * @description If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events. _Optional_: use the fine-grained token with following permission set to view private events: "Events" user permissions (read). + * + * > [!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-events-for-authenticated-user"]; }; @@ -8948,11 +9738,18 @@ export interface paths { /** * 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. + * + * > [!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-org-events-for-authenticated-user"]; }; "/users/{username}/events/public": { - /** List public events for a user */ + /** + * List public events for a user + * @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-public-events-for-user"]; }; "/users/{username}/followers": { @@ -9028,7 +9825,7 @@ export interface paths { * 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. For more information, 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"]; }; @@ -9037,7 +9834,7 @@ export interface paths { * 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. For more information, 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"]; /** @@ -9046,7 +9843,7 @@ export interface paths { * * 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. For more information, 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"]; }; @@ -9061,7 +9858,7 @@ export interface paths { * * 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. For more information, 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"]; }; @@ -9070,7 +9867,7 @@ export interface paths { * 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. For more information, 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"]; }; @@ -9079,7 +9876,7 @@ export interface paths { * 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. For more information, 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"]; /** @@ -9088,7 +9885,7 @@ export interface paths { * * 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. For more information, 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"]; }; @@ -9103,7 +9900,7 @@ export interface paths { * * 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. For more information, 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"]; }; @@ -9117,12 +9914,20 @@ export interface paths { "/users/{username}/received_events": { /** * 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. + * @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. + * + * > [!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-received-events-for-user"]; }; "/users/{username}/received_events/public": { - /** List public events received by a user */ + /** + * List public events received by a user + * @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-received-public-events-for-user"]; }; "/users/{username}/repos": { @@ -9257,6 +10062,22 @@ export interface paths { */ get: operations["repos/compare-commits"]; }; + "/orgs/{org}/organization-fine-grained-permissions": { + /** + * 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. + */ + get: operations["orgs/list-organization-fine-grained-permissions"]; + }; } export type webhooks = Record; @@ -9367,6 +10188,20 @@ export interface components { /** @description The functions in the package that are affected by the vulnerability. */ vulnerable_functions: readonly string[] | null; }; + "cvss-severities": { + cvss_v3?: { + /** @description The CVSS 3 vector string. */ + vector_string: string | null; + /** @description The CVSS 3 score. */ + score: number | null; + } | null; + cvss_v4?: { + /** @description The CVSS 4 vector string. */ + vector_string: string | null; + /** @description The CVSS 4 score. */ + score: number | null; + } | null; + } | null; /** * Simple User * @description A GitHub user. @@ -9376,7 +10211,10 @@ export interface components { email?: string | null; /** @example octocat */ login: string; - /** @example 1 */ + /** + * Format: int64 + * @example 1 + */ id: number; /** @example MDQ6VXNlcjE= */ node_id: string; @@ -9435,6 +10273,8 @@ export interface components { site_admin: boolean; /** @example "2020-07-09T00:17:55Z" */ starred_at?: string; + /** @example public */ + user_view_type?: string; }; /** * @description The type of credit the user is receiving. @@ -9534,6 +10374,7 @@ export interface components { /** @description The CVSS score. */ score: number | null; } | null; + cvss_severities?: components["schemas"]["cvss-severities"]; cwes: | { /** @description The Common Weakness Enumeration (CWE) identifier. */ @@ -9542,6 +10383,10 @@ export interface components { name: string; }[] | null; + epss?: { + percentage?: number; + percentile?: number; + } | null; /** @description The users who contributed to the advisory. */ credits: | readonly { @@ -9578,7 +10423,10 @@ export interface components { email?: string | null; /** @example octocat */ login: string; - /** @example 1 */ + /** + * Format: int64 + * @example 1 + */ id: number; /** @example MDQ6VXNlcjE= */ node_id: string; @@ -9637,6 +10485,8 @@ export interface components { site_admin: boolean; /** @example "2020-07-09T00:17:55Z" */ starred_at?: string; + /** @example public */ + user_view_type?: string; } | null; /** * GitHub app @@ -9655,6 +10505,8 @@ export interface components { slug?: string; /** @example MDExOkludGVncmF0aW9uMQ== */ node_id: string; + /** @example "Iv1.25b5d1e65ffc4022" */ + client_id?: string; owner: components["schemas"]["nullable-simple-user"]; /** * @description The name of the GitHub app @@ -9711,8 +10563,6 @@ export interface components { * @example 5 */ installations_count?: number; - /** @example "Iv1.25b5d1e65ffc4022" */ - client_id?: string; /** @example "1d4b2097ac622ba702d19de498f005747a8b21d3" */ client_secret?: string; /** @example "6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b" */ @@ -9808,6 +10658,12 @@ export interface components { * @example 123 */ repository_id: number | null; + /** + * Format: date-time + * @description Time when the webhook delivery was throttled. + * @example 2021-05-12T20:33:44Z + */ + throttled_at?: string | null; }; /** * Scim Error @@ -9898,6 +10754,12 @@ export interface components { * @example 123 */ repository_id: number | null; + /** + * Format: date-time + * @description Time when the webhook delivery was throttled. + * @example 2021-05-12T20:33:44Z + */ + throttled_at?: string | null; /** * @description The URL target of the delivery. * @example https://www.example.com @@ -10143,7 +11005,7 @@ export interface components { */ organization_custom_properties?: "read" | "write" | "admin"; /** - * @description The level of permission to grant the access token for managing access to GitHub Copilot for members of an organization with a Copilot Business subscription. This property is in beta and is subject to change. + * @description The level of permission to grant the access token for managing access to GitHub Copilot for members of an organization with a Copilot Business subscription. This property is in public preview and is subject to change. * @enum {string} */ organization_copilot_seat_management?: "write"; @@ -10178,7 +11040,7 @@ export interface components { */ organization_plan?: "read"; /** - * @description The level of permission to grant the access token to manage organization projects and projects beta (where available). + * @description The level of permission to grant the access token to manage organization projects and projects public preview (where available). * @enum {string} */ organization_projects?: "read" | "write" | "admin"; @@ -10337,6 +11199,7 @@ export interface components { */ repository: { /** + * Format: int64 * @description Unique identifier of the repository * @example 42 */ @@ -10628,7 +11491,7 @@ export interface components { 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. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -10741,6 +11604,7 @@ export interface components { * @description The authorization for an OAuth app, GitHub App, or a Personal Access Token. */ authorization: { + /** Format: int64 */ id: number; /** Format: uri */ url: string; @@ -11212,184 +12076,156 @@ export interface components { /** Format: uri */ html_url: string | null; }; - /** - * Copilot Usage Metrics - * @description Summary of Copilot usage. - */ - "copilot-usage-metrics": { + /** @description A code security configuration */ + "code-security-configuration": { + /** @description The ID of the code security configuration */ + id?: number; + /** @description The name of the code security configuration. Must be unique within the organization. */ + name?: string; /** - * Format: date - * @description The date for which the usage metrics are reported, in `YYYY-MM-DD` format. + * @description The type of the code security configuration. + * @enum {string} */ - day: string; - /** @description The total number of Copilot code completion suggestions shown to users. */ - total_suggestions_count?: number; - /** @description The total number of Copilot code completion suggestions accepted by users. */ - total_acceptances_count?: number; - /** @description The total number of lines of code completions suggested by Copilot. */ - total_lines_suggested?: number; - /** @description The total number of lines of code completions accepted by users. */ - total_lines_accepted?: number; - /** @description The total number of users who were shown Copilot code completion suggestions during the day specified. */ - total_active_users?: number; - /** @description The total instances of users who accepted code suggested by Copilot Chat in the IDE (panel and inline). */ - total_chat_acceptances?: number; - /** @description The total number of chat turns (prompt and response pairs) sent between users and Copilot Chat in the IDE. */ - total_chat_turns?: number; - /** @description The total number of users who interacted with Copilot Chat in the IDE during the day specified. */ - total_active_chat_users?: number; - /** @description Breakdown of Copilot code completions usage by language and editor */ - breakdown: - | { - /** @description The language in which Copilot suggestions were shown to users in the specified editor. */ - language?: string; - /** @description The editor in which Copilot suggestions were shown to users for the specified language. */ - editor?: string; - /** @description The number of Copilot suggestions shown to users in the editor specified during the day specified. */ - suggestions_count?: number; - /** @description The number of Copilot suggestions accepted by users in the editor specified during the day specified. */ - acceptances_count?: number; - /** @description The number of lines of code suggested by Copilot in the editor specified during the day specified. */ - lines_suggested?: number; - /** @description The number of lines of code accepted by users in the editor specified during the day specified. */ - lines_accepted?: number; - /** @description The number of users who were shown Copilot completion suggestions in the editor specified during the day specified. */ - active_users?: number; - [key: string]: unknown; - }[] - | null; - }; - /** @description The security alert number. */ - readonly "alert-number": number; - /** @description Details for the vulnerable package. */ - readonly "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"]; + target_type?: "global" | "organization" | "enterprise"; + /** @description A description of the code security configuration */ + description?: string; /** - * @description The severity of the vulnerability. + * @description The enablement status of GitHub Advanced Security * @enum {string} */ - readonly severity: "low" | "medium" | "high" | "critical"; - /** @description Conditions that identify vulnerable versions of this vulnerability's package. */ - readonly vulnerable_version_range: string; - /** @description Details pertaining to the package version that patches this vulnerability. */ - readonly first_patched_version: { - /** @description The package version that patches this vulnerability. */ - readonly identifier: string; - } | null; - }; - /** @description Details for the GitHub Security Advisory. */ - readonly "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. */ - readonly cve_id: string | null; - /** @description A short, plain text summary of the advisory. */ - readonly summary: string; - /** @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"][]; + advanced_security?: "enabled" | "disabled"; /** - * @description The severity of the advisory. + * @description The enablement status of Dependency Graph * @enum {string} */ - readonly severity: "low" | "medium" | "high" | "critical"; - /** @description Details for the advisory pertaining to the Common Vulnerability Scoring System. */ - readonly cvss: { - /** @description The overall CVSS score of the advisory. */ - readonly score: number; - /** @description The full CVSS vector string for the advisory. */ - readonly vector_string: string | null; + dependency_graph?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Automatic dependency submission + * @enum {string} + */ + dependency_graph_autosubmit_action?: "enabled" | "disabled" | "not_set"; + /** @description Feature options for Automatic dependency submission */ + dependency_graph_autosubmit_action_options?: { + /** @description Whether to use runners labeled with 'dependency-submission' or standard GitHub runners. */ + labeled_runners?: boolean; }; - /** @description Details for the advisory pertaining to Common Weakness Enumeration. */ - readonly cwes: readonly { - /** @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 { - /** - * @description The type of advisory identifier. - * @enum {string} - */ - readonly type: "CVE" | "GHSA"; - /** @description The value of the advisory identifer. */ - readonly value: string; - }[]; - /** @description Links to additional advisory information. */ - readonly references: readonly { + /** + * @description The enablement status of Dependabot alerts + * @enum {string} + */ + dependabot_alerts?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Dependabot security updates + * @enum {string} + */ + dependabot_security_updates?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of code scanning default setup + * @enum {string} + */ + code_scanning_default_setup?: "enabled" | "disabled" | "not_set"; + /** @description Feature options for code scanning default setup */ + code_scanning_default_setup_options?: { /** - * Format: uri - * @description The URL of the reference. + * @description Whether to use labeled runners or standard GitHub runners. + * @enum {string|null} */ - readonly url: string; - }[]; + runner_type?: "standard" | "labeled" | "not_set" | null; + /** @description The label of the runner to use for code scanning when runner_type is 'labeled'. */ + runner_label?: string | null; + } | null; /** - * Format: date-time - * @description The time that the advisory was published in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @description The enablement status of secret scanning + * @enum {string} */ - readonly published_at: string; + secret_scanning?: "enabled" | "disabled" | "not_set"; /** - * Format: date-time - * @description The time that the advisory was last modified in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @description The enablement status of secret scanning push protection + * @enum {string} */ - readonly updated_at: string; + secret_scanning_push_protection?: "enabled" | "disabled" | "not_set"; /** - * Format: date-time - * @description The time that the advisory was withdrawn in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @description The enablement status of secret scanning delegated bypass + * @enum {string} */ - readonly withdrawn_at: string | null; + secret_scanning_delegated_bypass?: "enabled" | "disabled" | "not_set"; + /** @description Feature options for secret scanning delegated bypass */ + secret_scanning_delegated_bypass_options?: { + /** @description The bypass reviewers for secret scanning delegated bypass */ + reviewers?: { + /** @description The ID of the team or role selected as a bypass reviewer */ + reviewer_id: number; + /** + * @description The type of the bypass reviewer + * @enum {string} + */ + reviewer_type: "TEAM" | "ROLE"; + }[]; + }; + /** + * @description The enablement status of secret scanning validity checks + * @enum {string} + */ + secret_scanning_validity_checks?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning non-provider patterns + * @enum {string} + */ + secret_scanning_non_provider_patterns?: + | "enabled" + | "disabled" + | "not_set"; + /** + * @description The enablement status of private vulnerability reporting + * @enum {string} + */ + private_vulnerability_reporting?: "enabled" | "disabled" | "not_set"; + /** + * @description The enforcement status for a security configuration + * @enum {string} + */ + enforcement?: "enforced" | "unenforced"; + /** + * Format: uri + * @description The URL of the configuration + */ + url?: string; + /** + * Format: uri + * @description The URL of the configuration + */ + html_url?: string; + /** Format: date-time */ + created_at?: string; + /** Format: date-time */ + updated_at?: string; }; - /** - * Format: uri - * @description The REST API URL of the alert resource. - */ - readonly "alert-url": string; - /** - * Format: uri - * @description The GitHub URL of the alert resource. - */ - readonly "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; - /** - * 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; - /** - * 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; - /** - * 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; - /** - * 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; + /** @description Feature options for code scanning default setup */ + "code-scanning-default-setup-options": { + /** + * @description Whether to use labeled runners or standard GitHub runners. + * @enum {string} + */ + runner_type?: "standard" | "labeled" | "not_set"; + /** @description The label of the runner to use for code scanning default setup when runner_type is 'labeled'. */ + runner_label?: string | null; + } | null; + /** @description A list of default code security configurations */ + "code-security-default-configurations": { + /** + * @description The visibility of newly created repositories for which the code security configuration will be applied to by default + * @enum {unknown} + */ + default_for_new_repos?: "public" | "private_and_internal" | "all"; + configuration?: components["schemas"]["code-security-configuration"]; + }[]; /** * Simple Repository * @description A GitHub repository. */ "simple-repository": { /** + * Format: int64 * @description A unique identifier of the repository. * @example 1296269 */ @@ -11625,6 +12461,149 @@ export interface components { */ hooks_url: string; }; + /** @description Repositories associated with a code security configuration and attachment status */ + "code-security-configuration-repositories": { + /** + * @description The attachment status of the code security configuration on the repository. + * @enum {string} + */ + status?: + | "attached" + | "attaching" + | "detached" + | "removed" + | "enforced" + | "failed" + | "updating" + | "removed_by_enterprise"; + repository?: components["schemas"]["simple-repository"]; + }; + /** @description The security alert number. */ + readonly "alert-number": number; + /** @description Details for the vulnerable package. */ + readonly "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"]; + /** + * @description The severity of the vulnerability. + * @enum {string} + */ + readonly severity: "low" | "medium" | "high" | "critical"; + /** @description Conditions that identify vulnerable versions of this vulnerability's package. */ + readonly vulnerable_version_range: string; + /** @description Details pertaining to the package version that patches this vulnerability. */ + readonly first_patched_version: { + /** @description The package version that patches this vulnerability. */ + readonly identifier: string; + } | null; + }; + /** @description Details for the GitHub Security Advisory. */ + readonly "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. */ + readonly cve_id: string | null; + /** @description A short, plain text summary of the advisory. */ + readonly summary: string; + /** @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"][]; + /** + * @description The severity of the advisory. + * @enum {string} + */ + readonly severity: "low" | "medium" | "high" | "critical"; + /** @description Details for the advisory pertaining to the Common Vulnerability Scoring System. */ + readonly cvss: { + /** @description The overall CVSS score of the advisory. */ + readonly score: number; + /** @description The full CVSS vector string for the advisory. */ + readonly vector_string: string | null; + }; + readonly cvss_severities?: components["schemas"]["cvss-severities"]; + /** @description Details for the advisory pertaining to Common Weakness Enumeration. */ + readonly cwes: readonly { + /** @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 { + /** + * @description The type of advisory identifier. + * @enum {string} + */ + readonly type: "CVE" | "GHSA"; + /** @description The value of the advisory identifer. */ + readonly value: string; + }[]; + /** @description Links to additional advisory information. */ + readonly references: readonly { + /** + * Format: uri + * @description The URL of the reference. + */ + readonly url: string; + }[]; + /** + * Format: date-time + * @description The time that the advisory was published in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + readonly published_at: string; + /** + * Format: date-time + * @description The time that the advisory was last modified in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + readonly updated_at: string; + /** + * Format: date-time + * @description The time that the advisory was withdrawn in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + readonly withdrawn_at: string | null; + }; + /** + * Format: uri + * @description The REST API URL of the alert resource. + */ + readonly "alert-url": string; + /** + * Format: uri + * @description The GitHub URL of the alert resource. + */ + readonly "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; + /** + * 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; + /** + * 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; + /** + * 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; + /** + * 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; /** @description A Dependabot alert. */ "dependabot-alert-with-repository": { number: components["schemas"]["alert-number"]; @@ -11712,7 +12691,7 @@ export interface components { 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)." + * For a list of built-in patterns, see "[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)." */ secret_type_display_name?: string; /** @description The secret that was detected. */ @@ -11726,6 +12705,16 @@ export interface components { * @description The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ push_protection_bypassed_at?: string | null; + push_protection_bypass_request_reviewer?: components["schemas"]["nullable-simple-user"]; + /** @description An optional comment when reviewing a push protection bypass. */ + push_protection_bypass_request_reviewer_comment?: string | null; + /** @description An optional comment when requesting a push protection bypass. */ + push_protection_bypass_request_comment?: string | null; + /** + * Format: uri + * @description The URL to a push protection bypass request. + */ + push_protection_bypass_request_html_url?: string | null; /** @description The comment that was optionally added when this alert was closed */ resolution_comment?: string | null; /** @@ -11733,6 +12722,10 @@ export interface components { * @enum {string} */ validity?: "active" | "inactive" | "unknown"; + /** @description Whether the secret was publicly leaked. */ + publicly_leaked?: boolean | null; + /** @description Whether the detected secret was found in multiple repositories in the same organization or enterprise. */ + multi_repo?: boolean | null; }; /** * Actor @@ -11834,6 +12827,8 @@ export interface components { slug?: string; /** @example MDExOkludGVncmF0aW9uMQ== */ node_id: string; + /** @example "Iv1.25b5d1e65ffc4022" */ + client_id?: string; owner: components["schemas"]["nullable-simple-user"]; /** * @description The name of the GitHub app @@ -11890,8 +12885,6 @@ export interface components { * @example 5 */ installations_count?: number; - /** @example "Iv1.25b5d1e65ffc4022" */ - client_id?: string; /** @example "1d4b2097ac622ba702d19de498f005747a8b21d3" */ client_secret?: string; /** @example "6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b" */ @@ -11928,6 +12921,12 @@ export interface components { eyes: number; rocket: number; }; + /** Sub-issues Summary */ + "sub-issues-summary": { + total: number; + completed: number; + percent_completed: number; + }; /** * Issue * @description Issues are a great way to keep track of tasks, enhancements, and bugs for your projects. @@ -12035,6 +13034,7 @@ export interface components { performed_via_github_app?: components["schemas"]["nullable-integration"]; author_association: components["schemas"]["author-association"]; reactions?: components["schemas"]["reaction-rollup"]; + sub_issues_summary?: components["schemas"]["sub-issues-summary"]; }; /** * Issue Comment @@ -12194,6 +13194,11 @@ export interface components { language?: string; raw_url?: string; size?: number; + /** + * @description The encoding used for `content`. Currently, `"utf-8"` and `"base64"` are supported. + * @default utf-8 + */ + encoding?: string; }; }; public: boolean; @@ -12203,6 +13208,7 @@ export interface components { updated_at: string; description: string | null; comments: number; + comments_enabled?: boolean; user: components["schemas"]["nullable-simple-user"]; /** Format: uri */ comments_url: string; @@ -12217,7 +13223,9 @@ export interface components { */ "public-user": { login: string; + /** Format: int64 */ id: number; + user_view_type?: string; node_id: string; /** Format: uri */ avatar_url: string; @@ -12248,6 +13256,8 @@ export interface components { location: string | null; /** Format: email */ email: string | null; + /** Format: email */ + notification_email?: string | null; hireable: boolean | null; bio: string | null; twitter_username?: string | null; @@ -12265,8 +13275,6 @@ export interface components { space: number; private_repos: number; }; - /** Format: date-time */ - suspended_at?: string | null; /** @example 1 */ private_gists?: number; /** @example 2 */ @@ -12350,6 +13358,7 @@ export interface components { updated_at: string; description: string | null; comments: number; + comments_enabled?: boolean; user: components["schemas"]["nullable-simple-user"]; /** Format: uri */ comments_url: string; @@ -12375,6 +13384,11 @@ export interface components { size?: number; truncated?: boolean; content?: string; + /** + * @description The encoding used for `content`. Currently, `"utf-8"` and `"base64"` are supported. + * @default utf-8 + */ + encoding?: string; } | null; }; public?: boolean; @@ -12382,6 +13396,7 @@ export interface components { updated_at?: string; description?: string | null; comments?: number; + comments_enabled?: boolean; user?: string | null; comments_url?: string; owner?: components["schemas"]["simple-user"]; @@ -12717,18 +13732,49 @@ export interface components { * ] */ actions?: string[]; + /** + * @example [ + * "192.0.2.1" + * ] + */ + actions_macos?: string[]; + /** + * @example [ + * "192.0.2.1" + * ] + */ + codespaces?: string[]; /** * @example [ * "192.0.2.1" * ] */ dependabot?: string[]; + /** + * @example [ + * "192.0.2.1" + * ] + */ + copilot?: string[]; domains?: { website?: string[]; codespaces?: string[]; copilot?: string[]; packages?: string[]; actions?: string[]; + actions_inbound?: { + full_domains?: string[]; + wildcard_domains?: string[]; + }; + artifact_attestations?: { + /** + * @example [ + * "example" + * ] + */ + trust_domain?: string; + services?: string[]; + }; }; }; "security-and-analysis": { @@ -12752,13 +13798,24 @@ export interface components { /** @enum {string} */ status?: "enabled" | "disabled"; }; + secret_scanning_non_provider_patterns?: { + /** @enum {string} */ + status?: "enabled" | "disabled"; + }; + secret_scanning_ai_detection?: { + /** @enum {string} */ + status?: "enabled" | "disabled"; + }; } | null; /** * Minimal Repository * @description Minimal Repository */ "minimal-repository": { - /** @example 1296269 */ + /** + * Format: int64 + * @example 1296269 + */ id: number; /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */ node_id: string; @@ -13054,6 +14111,32 @@ export interface components { /** @example A great organization */ description: string | null; }; + "billing-usage-report": { + usageItems?: { + /** @description Date of the usage line item. */ + date: string; + /** @description Product name. */ + product: string; + /** @description SKU name. */ + sku: string; + /** @description Quantity of the usage line item. */ + quantity: number; + /** @description Unit type of the usage line item. */ + unitType: string; + /** @description Price per unit of the usage line item. */ + pricePerUnit: number; + /** @description Gross amount of the usage line item. */ + grossAmount: number; + /** @description Discount amount of the usage line item. */ + discountAmount: number; + /** @description Net amount of the usage line item. */ + netAmount: number; + /** @description Name of the organization. */ + organizationName: string; + /** @description Name of the repository. */ + repositoryName?: string; + }[]; + }; /** * Organization Full * @description Organization Full @@ -13139,7 +14222,12 @@ export interface components { private_gists?: number | null; /** @example 10000 */ disk_usage?: number | null; - /** @example 8 */ + /** + * @description The number of collaborators on private repositories. + * + * This field may be null if the number of private repositories is over 50,000. + * @example 8 + */ collaborators?: number | null; /** * Format: email @@ -13177,47 +14265,60 @@ export interface components { /** @example false */ web_commit_signoff_required?: boolean; /** - * @description Whether GitHub Advanced Security is enabled for new repositories and repositories transferred to this organization. + * @deprecated + * @description **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + * + * 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. * @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. + * @deprecated + * @description **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + * + * Whether Dependabot alerts are automatically 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. * @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. + * @deprecated + * @description **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + * + * Whether Dependabot security updates are automatically 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. * @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. + * @deprecated + * @description **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + * + * Whether dependency graph is automatically 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. * @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. + * @deprecated + * @description **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + * + * Whether secret scanning is automatically 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. * @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. + * @deprecated + * @description **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + * + * Whether secret scanning push protection is automatically 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. * @example false @@ -13242,6 +14343,11 @@ export interface components { updated_at: string; /** Format: date-time */ archived_at: string | null; + /** + * @description Controls whether or not deploy keys may be added and used for repositories in the organization. + * @example false + */ + deploy_keys_enabled_for_repositories?: boolean; }; "actions-cache-usage-org-enterprise": { /** @description The count of active caches across all repositories of an enterprise or an organization. */ @@ -13310,7 +14416,8 @@ export interface components { /** * @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[]; }; @@ -13329,6 +14436,31 @@ export interface components { default_workflow_permissions?: components["schemas"]["actions-default-workflow-permissions"]; can_approve_pull_request_reviews?: components["schemas"]["actions-can-approve-pull-request-reviews"]; }; + "runner-groups-org": { + id: number; + name: string; + visibility: string; + default: boolean; + /** @description Link to the selected repositories resource for this runner group. Not present unless visibility was set to `selected` */ + selected_repositories_url?: string; + runners_url: string; + hosted_runners_url?: string; + inherited: boolean; + inherited_allows_public_repositories?: boolean; + allows_public_repositories: boolean; + /** + * @description If `true`, the `restricted_to_workflows` and `selected_workflows` fields cannot be modified. + * @default false + */ + 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; + /** @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[]; + }; /** * Self hosted runner label * @description A label for a self hosted runner @@ -13542,18 +14674,18 @@ export interface components { readonly "alert-instances-url": string; /** * @description State of a code scanning alert. - * @enum {string} + * @enum {string|null} */ - "code-scanning-alert-state": "open" | "dismissed" | "fixed"; + "code-scanning-alert-state": "open" | "dismissed" | "fixed" | null; /** * @description **Required when the state is dismissed.** The reason for dismissing or closing the alert. * @enum {string|null} */ "code-scanning-alert-dismissed-reason": - | null | "false positive" | "won't fix" - | "used in tests"; + | "used in tests" + | null; /** @description The dismissal comment associated with the dismissal of the alert. */ "code-scanning-alert-dismissed-comment": string | null; "code-scanning-alert-rule-summary": { @@ -13561,8 +14693,6 @@ export interface components { id?: string | null; /** @description The name of the rule used to detect the alert. */ name?: string; - /** @description A set of tags applicable for the rule. */ - tags?: string[] | null; /** * @description The severity of the alert. * @enum {string|null} @@ -13575,6 +14705,14 @@ export interface components { security_severity_level?: "low" | "medium" | "high" | "critical" | null; /** @description A short description of the rule used to detect the alert. */ description?: string; + /** @description A description of the rule used to detect the alert. */ + full_description?: string; + /** @description A set of tags applicable for the rule. */ + tags?: string[] | null; + /** @description Detailed documentation for the rule as GitHub Flavored Markdown. */ + help?: string | null; + /** @description A link to the documentation for the rule used to detect the alert. */ + help_uri?: string | null; }; /** @description The version of the tool used to generate the code scanning analysis. */ "code-scanning-analysis-tool-version": string | null; @@ -13695,7 +14833,10 @@ export interface components { * @description A codespace. */ codespace: { - /** @example 1 */ + /** + * Format: int64 + * @example 1 + */ id: number; /** * @description Automatically generated name of this codespace. @@ -13936,8 +15077,8 @@ export interface components { inactive_this_cycle?: number; }; /** - * Copilot Business Organization Details - * @description Information about the seat breakdown and policies set for an organization with a Copilot Business subscription. + * Copilot Organization Details + * @description Information about the seat breakdown and policies set for an organization with a Copilot Business or Copilot Enterprise subscription. */ "copilot-organization-details": { seat_breakdown: components["schemas"]["copilot-seat-breakdown"]; @@ -13970,8 +15111,52 @@ export interface components { | "assign_selected" | "disabled" | "unconfigured"; + /** + * @description The Copilot plan of the organization, or the parent enterprise, when applicable. + * @enum {string} + */ + plan_type?: "business" | "enterprise" | "unknown"; [key: string]: unknown; }; + /** + * Organization Simple + * @description A GitHub organization. + */ + "nullable-organization-simple": { + /** @example github */ + login: string; + /** @example 1 */ + id: number; + /** @example MDEyOk9yZ2FuaXphdGlvbjE= */ + node_id: string; + /** + * Format: uri + * @example https://api.github.com/orgs/github + */ + url: string; + /** + * Format: uri + * @example https://api.github.com/orgs/github/repos + */ + repos_url: string; + /** + * Format: uri + * @example https://api.github.com/orgs/github/events + */ + events_url: string; + /** @example https://api.github.com/orgs/github/hooks */ + hooks_url: string; + /** @example https://api.github.com/orgs/github/issues */ + issues_url: string; + /** @example https://api.github.com/orgs/github/members{/member} */ + members_url: string; + /** @example https://api.github.com/orgs/github/public_members{/member} */ + public_members_url: string; + /** @example https://github.com/images/error/octocat_happy.gif */ + avatar_url: string; + /** @example A great organization */ + description: string | null; + } | null; /** * Team Simple * @description Groups of organization members that gives permissions on specified repositories. @@ -14068,99 +15253,43 @@ export interface components { parent: components["schemas"]["nullable-team-simple"]; }; /** - * Organization - * @description GitHub account for managing multiple users, teams, and repositories + * Enterprise Team + * @description Group of enterprise owners and/or members */ - organization: { - /** - * @description Unique login name of the organization - * @example new-org - */ - login: string; - /** - * Format: uri - * @description URL for the organization - * @example https://api.github.com/orgs/github - */ - url: string; + "enterprise-team": { + /** Format: int64 */ id: number; - node_id: string; - /** Format: uri */ - repos_url: string; + name: string; + slug: string; /** Format: uri */ - events_url: string; - hooks_url: string; - issues_url: string; - members_url: string; - public_members_url: string; - avatar_url: string; - description: string | null; + url: string; + /** @example disabled | all */ + sync_to_organizations: string; + /** @example 62ab9291-fae2-468e-974b-7e45096d5021 */ + group_id?: string | null; /** * Format: uri - * @description Display blog url for the organization - * @example blog.example-org.com + * @example https://github.com/enterprises/dc/teams/justice-league */ - blog?: string; - /** Format: uri */ html_url: string; - /** - * @description Display name for the organization - * @example New Org - */ - name?: string; - /** - * @description Display company name for the organization - * @example Acme corporation - */ - company?: string; - /** - * @description Display location for the organization - * @example Berlin, Germany - */ - location?: string; - /** - * Format: email - * @description Display email for the organization - * @example org@example.com - */ - email?: string; - /** @description Specifies if organization projects are enabled for this org */ - has_organization_projects: boolean; - /** @description Specifies if repository projects are enabled for repositories that belong to this org */ - has_repository_projects: boolean; - is_verified?: boolean; - public_repos: number; - public_gists: number; - followers: number; - following: number; - type: string; + members_url: string; /** Format: date-time */ created_at: string; /** Format: date-time */ updated_at: string; - plan?: { - name?: string; - space?: number; - private_repos?: number; - filled_seats?: number; - seats?: number; - }; }; /** * Copilot Business Seat Detail * @description Information about a Copilot Business seat assignment for a user, team, or organization. */ "copilot-seat-details": { - /** @description The assignee that has been granted access to GitHub Copilot. */ - assignee: { - [key: string]: unknown; - } & ( - | components["schemas"]["simple-user"] + assignee: components["schemas"]["simple-user"]; + organization?: components["schemas"]["nullable-organization-simple"]; + /** @description The team through which the assignee is granted access to GitHub Copilot, if applicable. */ + assigning_team?: | components["schemas"]["team"] - | components["schemas"]["organization"] - ); - /** @description The team that granted access to GitHub Copilot to the assignee. This will be null if the user was assigned a seat individually. */ - assigning_team?: components["schemas"]["team"] | null; + | components["schemas"]["enterprise-team"] + | null; /** * Format: date * @description The pending cancellation date for the seat, in `YYYY-MM-DD` format. This will be null unless the assignee's Copilot access has been canceled during the current billing cycle. If the seat has been cancelled, this corresponds to the start of the organization's next billing cycle. @@ -14180,9 +15309,202 @@ export interface components { created_at: string; /** * Format: date-time - * @description Timestamp of when the assignee's GitHub Copilot access was last updated, in ISO 8601 format. + * @deprecated + * @description **Closing down notice:** This field is no longer relevant and is closing down. Use the `created_at` field to determine when the assignee was last granted access to GitHub Copilot. Timestamp of when the assignee's GitHub Copilot access was last updated, in ISO 8601 format. */ updated_at?: string; + /** + * @description The Copilot plan of the organization, or the parent enterprise, when applicable. + * @enum {string} + */ + plan_type?: "business" | "enterprise" | "unknown"; + }; + /** @description Usage metrics for Copilot editor code completions in the IDE. */ + "copilot-ide-code-completions": { + /** @description Number of users who accepted at least one Copilot code suggestion, across all active editors. Includes both full and partial acceptances. */ + total_engaged_users?: number; + /** @description Code completion metrics for active languages. */ + languages?: { + /** @description Name of the language used for Copilot code completion suggestions. */ + name?: string; + /** @description Number of users who accepted at least one Copilot code completion suggestion for the given language. Includes both full and partial acceptances. */ + total_engaged_users?: number; + }[]; + editors?: { + /** @description Name of the given editor. */ + name?: string; + /** @description Number of users who accepted at least one Copilot code completion suggestion for the given editor. Includes both full and partial acceptances. */ + total_engaged_users?: number; + /** @description List of model metrics for custom models and the default model. */ + models?: { + /** @description Name of the model used for Copilot code completion suggestions. If the default model is used will appear as 'default'. */ + name?: string; + /** @description Indicates whether a model is custom or default. */ + is_custom_model?: boolean; + /** @description The training date for the custom model. */ + custom_model_training_date?: string | null; + /** @description Number of users who accepted at least one Copilot code completion suggestion for the given editor, for the given language and model. Includes both full and partial acceptances. */ + total_engaged_users?: number; + /** @description Code completion metrics for active languages, for the given editor. */ + languages?: { + /** @description Name of the language used for Copilot code completion suggestions, for the given editor. */ + name?: string; + /** @description Number of users who accepted at least one Copilot code completion suggestion for the given editor, for the given language. Includes both full and partial acceptances. */ + total_engaged_users?: number; + /** @description The number of Copilot code suggestions generated for the given editor, for the given language. */ + total_code_suggestions?: number; + /** @description The number of Copilot code suggestions accepted for the given editor, for the given language. Includes both full and partial acceptances. */ + total_code_acceptances?: number; + /** @description The number of lines of code suggested by Copilot code completions for the given editor, for the given language. */ + total_code_lines_suggested?: number; + /** @description The number of lines of code accepted from Copilot code suggestions for the given editor, for the given language. */ + total_code_lines_accepted?: number; + }[]; + }[]; + [key: string]: unknown; + }[]; + [key: string]: unknown; + } | null; + /** @description Usage metrics for Copilot Chat in the IDE. */ + "copilot-ide-chat": { + /** @description Total number of users who prompted Copilot Chat in the IDE. */ + total_engaged_users?: number; + editors?: { + /** @description Name of the given editor. */ + name?: string; + /** @description The number of users who prompted Copilot Chat in the specified editor. */ + total_engaged_users?: number; + /** @description List of model metrics for custom models and the default model. */ + models?: { + /** @description Name of the model used for Copilot code completion suggestions. If the default model is used will appear as 'default'. */ + name?: string; + /** @description Indicates whether a model is custom or default. */ + is_custom_model?: boolean; + /** @description The training date for the custom model. */ + custom_model_training_date?: string | null; + /** @description The number of users who prompted Copilot Chat in the given editor and model. */ + total_engaged_users?: number; + /** @description The total number of chats initiated by users in the given editor and model. */ + total_chats?: number; + /** @description The number of times users accepted a code suggestion from Copilot Chat using the 'Insert Code' UI element, for the given editor. */ + total_chat_insertion_events?: number; + /** @description The number of times users copied a code suggestion from Copilot Chat using the keyboard, or the 'Copy' UI element, for the given editor. */ + total_chat_copy_events?: number; + }[]; + }[]; + [key: string]: unknown; + } | null; + /** @description Usage metrics for Copilot Chat in github.com */ + "copilot-dotcom-chat": { + /** @description Total number of users who prompted Copilot Chat on github.com at least once. */ + total_engaged_users?: number; + /** @description List of model metrics for a custom models and the default model. */ + models?: { + /** @description Name of the model used for Copilot code completion suggestions. If the default model is used will appear as 'default'. */ + name?: string; + /** @description Indicates whether a model is custom or default. */ + is_custom_model?: boolean; + /** @description The training date for the custom model (if applicable). */ + custom_model_training_date?: string | null; + /** @description Total number of users who prompted Copilot Chat on github.com at least once for each model. */ + total_engaged_users?: number; + /** @description Total number of chats initiated by users on github.com. */ + total_chats?: number; + }[]; + [key: string]: unknown; + } | null; + /** @description Usage metrics for Copilot for pull requests. */ + "copilot-dotcom-pull-requests": { + /** @description The number of users who used Copilot for Pull Requests on github.com to generate a pull request summary at least once. */ + total_engaged_users?: number; + /** @description Repositories in which users used Copilot for Pull Requests to generate pull request summaries */ + repositories?: { + /** @description Repository name */ + name?: string; + /** @description The number of users who generated pull request summaries using Copilot for Pull Requests in the given repository. */ + total_engaged_users?: number; + /** @description List of model metrics for custom models and the default model. */ + models?: { + /** @description Name of the model used for Copilot code completion suggestions. If the default model is used will appear as 'default'. */ + name?: string; + /** @description Indicates whether a model is custom or default. */ + is_custom_model?: boolean; + /** @description The training date for the custom model. */ + custom_model_training_date?: string | null; + /** @description The number of pull request summaries generated using Copilot for Pull Requests in the given repository. */ + total_pr_summaries_created?: number; + /** @description The number of users who generated pull request summaries using Copilot for Pull Requests in the given repository and model. */ + total_engaged_users?: number; + }[]; + }[]; + [key: string]: unknown; + } | null; + /** + * Copilot Usage Metrics + * @description Copilot usage metrics for a given day. + */ + "copilot-usage-metrics-day": { + /** + * Format: date + * @description The date for which the usage metrics are aggregated, in `YYYY-MM-DD` format. + */ + date: string; + /** @description The total number of Copilot users with activity belonging to any Copilot feature, globally, for the given day. Includes passive activity such as receiving a code suggestion, as well as engagement activity such as accepting a code suggestion or prompting chat. Does not include authentication events. Is not limited to the individual features detailed on the endpoint. */ + total_active_users?: number; + /** @description The total number of Copilot users who engaged with any Copilot feature, for the given day. Examples include but are not limited to accepting a code suggestion, prompting Copilot chat, or triggering a PR Summary. Does not include authentication events. Is not limited to the individual features detailed on the endpoint. */ + total_engaged_users?: number; + copilot_ide_code_completions?: components["schemas"]["copilot-ide-code-completions"]; + copilot_ide_chat?: components["schemas"]["copilot-ide-chat"]; + copilot_dotcom_chat?: components["schemas"]["copilot-dotcom-chat"]; + copilot_dotcom_pull_requests?: components["schemas"]["copilot-dotcom-pull-requests"]; + [key: string]: unknown; + }; + /** + * Copilot Usage Metrics + * @description Summary of Copilot usage. + */ + "copilot-usage-metrics": { + /** + * Format: date + * @description The date for which the usage metrics are reported, in `YYYY-MM-DD` format. + */ + day: string; + /** @description The total number of Copilot code completion suggestions shown to users. */ + total_suggestions_count?: number; + /** @description The total number of Copilot code completion suggestions accepted by users. */ + total_acceptances_count?: number; + /** @description The total number of lines of code completions suggested by Copilot. */ + total_lines_suggested?: number; + /** @description The total number of lines of code completions accepted by users. */ + total_lines_accepted?: number; + /** @description The total number of users who were shown Copilot code completion suggestions during the day specified. */ + total_active_users?: number; + /** @description The total instances of users who accepted code suggested by Copilot Chat in the IDE (panel and inline). */ + total_chat_acceptances?: number; + /** @description The total number of chat turns (prompt and response pairs) sent between users and Copilot Chat in the IDE. */ + total_chat_turns?: number; + /** @description The total number of users who interacted with Copilot Chat in the IDE during the day specified. */ + total_active_chat_users?: number; + /** @description Breakdown of Copilot code completions usage by language and editor */ + breakdown: + | { + /** @description The language in which Copilot suggestions were shown to users in the specified editor. */ + language?: string; + /** @description The editor in which Copilot suggestions were shown to users for the specified language. */ + editor?: string; + /** @description The number of Copilot suggestions shown to users in the editor specified during the day specified. */ + suggestions_count?: number; + /** @description The number of Copilot suggestions accepted by users in the editor specified during the day specified. */ + acceptances_count?: number; + /** @description The number of lines of code suggested by Copilot in the editor specified during the day specified. */ + lines_suggested?: number; + /** @description The number of lines of code accepted by users in the editor specified during the day specified. */ + lines_accepted?: number; + /** @description The number of users who were shown Copilot completion suggestions in the editor specified during the day specified. */ + active_users?: number; + [key: string]: unknown; + }[] + | null; }; /** * Dependabot Secret for an Organization @@ -14230,7 +15552,10 @@ export interface components { * @description Minimal Repository */ "nullable-minimal-repository": { - /** @example 1296269 */ + /** + * Format: int64 + * @example 1296269 + */ id: number; /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */ node_id: string; @@ -14488,6 +15813,7 @@ export interface components { * @description Organization Invitation */ "organization-invitation": { + /** Format: int64 */ id: number; login: string | null; email: string | null; @@ -14559,6 +15885,87 @@ export interface components { created_at: string; type: string; }; + /** + * Route Stats + * @description API Insights usage route stats for an actor + */ + "api-insights-route-stats": { + /** @description The HTTP method */ + http_method?: string; + /** @description The API path's route template */ + api_route?: string; + /** + * Format: int64 + * @description The total number of requests within the queried time period + */ + total_request_count?: number; + /** + * Format: int64 + * @description The total number of requests that were rate limited within the queried time period + */ + rate_limited_request_count?: number; + last_rate_limited_timestamp?: string | null; + last_request_timestamp?: string; + }[]; + /** + * Subject Stats + * @description API Insights usage subject stats for an organization + */ + "api-insights-subject-stats": { + subject_type?: string; + subject_name?: string; + /** Format: int64 */ + subject_id?: number; + total_request_count?: number; + rate_limited_request_count?: number; + last_rate_limited_timestamp?: string | null; + last_request_timestamp?: string; + }[]; + /** + * Summary Stats + * @description API Insights usage summary stats for an organization + */ + "api-insights-summary-stats": { + /** + * Format: int64 + * @description The total number of requests within the queried time period + */ + total_request_count?: number; + /** + * Format: int64 + * @description The total number of requests that were rate limited within the queried time period + */ + rate_limited_request_count?: number; + }; + /** + * Time Stats + * @description API Insights usage time stats for an organization + */ + "api-insights-time-stats": { + timestamp?: string; + /** Format: int64 */ + total_request_count?: number; + /** Format: int64 */ + rate_limited_request_count?: number; + }[]; + /** + * User Stats + * @description API Insights usage stats for a user + */ + "api-insights-user-stats": { + actor_type?: string; + actor_name?: string; + /** Format: int64 */ + actor_id?: number; + /** Format: int64 */ + integration_id?: number | null; + /** Format: int64 */ + oauth_application_id?: number | null; + total_request_count?: number; + rate_limited_request_count?: number; + last_rate_limited_timestamp?: string | null; + last_request_timestamp?: string; + }[]; /** * @description The type of GitHub user that can comment, open issues, or create pull requests while the interaction limit is in effect. * @example collaborators_only @@ -14639,7 +16046,10 @@ export interface components { * @description A migration. */ migration: { - /** @example 79 */ + /** + * Format: int64 + * @example 79 + */ id: number; owner: components["schemas"]["nullable-simple-user"]; /** @example 0b989ba4-242f-11e5-81e1-c7b6966d2516 */ @@ -14677,25 +16087,30 @@ export interface components { /** @description Exclude related items from being returned in the response in order to improve performance of the request. The array can include any of: `"repositories"`. */ exclude?: string[]; }; - /** - * Organization Fine-Grained Permission - * @description A fine-grained permission that protects organization resources. - */ - "organization-fine-grained-permission": { - name: string; - description: string; - }; /** * Organization Role * @description Organization roles */ "organization-role": { - /** @description The unique identifier of the role. */ + /** + * Format: int64 + * @description The unique identifier of the role. + */ id: number; /** @description The name of the role. */ name: string; /** @description A short description about who this role is for or what permissions it grants. */ description?: string | null; + /** + * @description The system role from which this role inherits permissions. + * @enum {string|null} + */ + base_role?: "read" | "triage" | "write" | "maintain" | "admin" | null; + /** + * @description Source answers the question, "where did this role come from?" + * @enum {string|null} + */ + source?: "Organization" | "Enterprise" | "Predefined" | null; /** @description A list of permissions included in this role. */ permissions: string[]; organization: components["schemas"]["nullable-simple-user"]; @@ -14710,6 +16125,186 @@ export interface components { */ updated_at: string; }; + /** + * A Role Assignment for a Team + * @description The Relationship a Team has with a role. + */ + "team-role-assignment": { + /** + * @description Determines if the team has a direct, indirect, or mixed relationship to a role + * @example direct + * @enum {string} + */ + assignment?: "direct" | "indirect" | "mixed"; + id: number; + node_id: string; + name: string; + slug: string; + description: string | null; + privacy?: string; + notification_setting?: string; + permission: string; + permissions?: { + pull: boolean; + triage: boolean; + push: boolean; + maintain: boolean; + admin: boolean; + }; + /** Format: uri */ + url: string; + /** + * Format: uri + * @example https://github.com/orgs/rails/teams/core + */ + html_url: string; + members_url: string; + /** Format: uri */ + repositories_url: string; + parent: components["schemas"]["nullable-team-simple"]; + }; + /** + * Team Simple + * @description Groups of organization members that gives permissions on specified repositories. + */ + "team-simple": { + /** + * @description Unique identifier of the team + * @example 1 + */ + id: number; + /** @example MDQ6VGVhbTE= */ + node_id: string; + /** + * Format: uri + * @description URL for the team + * @example https://api.github.com/organizations/1/team/1 + */ + url: string; + /** @example https://api.github.com/organizations/1/team/1/members{/member} */ + members_url: string; + /** + * @description Name of the team + * @example Justice League + */ + name: string; + /** + * @description Description of the team + * @example A great team. + */ + description: string | null; + /** + * @description Permission that the team will have for its repositories + * @example admin + */ + permission: string; + /** + * @description The level of privacy this team should have + * @example closed + */ + privacy?: string; + /** + * @description The notification setting the team has set + * @example notifications_enabled + */ + notification_setting?: string; + /** + * Format: uri + * @example https://github.com/orgs/rails/teams/core + */ + html_url: string; + /** + * Format: uri + * @example https://api.github.com/organizations/1/team/1/repos + */ + repositories_url: string; + /** @example justice-league */ + slug: string; + /** + * @description Distinguished Name (DN) that team maps to within LDAP environment + * @example uid=example,ou=users,dc=github,dc=com + */ + ldap_dn?: string; + }; + /** + * A Role Assignment for a User + * @description The Relationship a User has with a role. + */ + "user-role-assignment": { + /** + * @description Determines if the user has a direct, indirect, or mixed relationship to a role + * @example direct + * @enum {string} + */ + assignment?: "direct" | "indirect" | "mixed"; + /** @description Team the user has gotten the role through */ + inherited_from?: components["schemas"]["team-simple"][]; + name?: string | null; + email?: string | null; + /** @example octocat */ + login: string; + /** @example 1 */ + id: number; + /** @example MDQ6VXNlcjE= */ + node_id: string; + /** + * Format: uri + * @example https://github.com/images/error/octocat_happy.gif + */ + avatar_url: string; + /** @example 41d064eb2195891e12d0413f63227ea7 */ + gravatar_id: string | null; + /** + * Format: uri + * @example https://api.github.com/users/octocat + */ + url: string; + /** + * Format: uri + * @example https://github.com/octocat + */ + html_url: string; + /** + * Format: uri + * @example https://api.github.com/users/octocat/followers + */ + followers_url: string; + /** @example https://api.github.com/users/octocat/following{/other_user} */ + following_url: string; + /** @example https://api.github.com/users/octocat/gists{/gist_id} */ + gists_url: string; + /** @example https://api.github.com/users/octocat/starred{/owner}{/repo} */ + starred_url: string; + /** + * Format: uri + * @example https://api.github.com/users/octocat/subscriptions + */ + subscriptions_url: string; + /** + * Format: uri + * @example https://api.github.com/users/octocat/orgs + */ + organizations_url: string; + /** + * Format: uri + * @example https://api.github.com/users/octocat/repos + */ + repos_url: string; + /** @example https://api.github.com/users/octocat/events{/privacy} */ + events_url: string; + /** + * Format: uri + * @example https://api.github.com/users/octocat/received_events + */ + received_events_url: string; + /** @example User */ + type: string; + site_admin: boolean; + /** @example "2020-07-09T00:17:55Z" */ + starred_at?: string; + /** @example public */ + user_view_type?: string; + }; /** * Package Version * @description A version of a software package @@ -14803,6 +16398,10 @@ export interface components { }; /** @description Date and time when the request for access was created. */ created_at: string; + /** @description Unique identifier of the user's token. This field can also be found in audit log events and the organization's settings for their PAT grants. */ + token_id: number; + /** @description The name given to the user's token. This field can also be found in an organization's settings page for Active Tokens. */ + token_name: string; /** @description Whether the associated fine-grained personal access token has expired. */ token_expired: boolean; /** @description Date and time when the associated fine-grained personal access token expires. */ @@ -14815,7 +16414,7 @@ export interface components { * @description Minimal representation of an organization programmatic access grant for enumerations */ "organization-programmatic-access-grant": { - /** @description Unique identifier of the fine-grained personal access token. The `pat_id` used to get details about an approved fine-grained personal access token. */ + /** @description Unique identifier of the fine-grained personal access token grant. The `pat_id` used to get details about an approved fine-grained personal access token. */ id: number; owner: components["schemas"]["simple-user"]; /** @@ -14839,6 +16438,10 @@ export interface components { }; /** @description Date and time when the fine-grained personal access token was approved to access the organization. */ access_granted_at: string; + /** @description Unique identifier of the user's token. This field can also be found in audit log events and the organization's settings for their PAT grants. */ + token_id: number; + /** @description The name given to the user's token. This field can also be found in an organization's settings page for Active Tokens. */ + token_name: string; /** @description Whether the associated fine-grained personal access token has expired. */ token_expired: boolean; /** @description Date and time when the associated fine-grained personal access token expires. */ @@ -14846,6 +16449,68 @@ export interface components { /** @description Date and time when the associated fine-grained personal access token was last used for authentication. */ token_last_used_at: string | null; }; + /** + * Organization private registry + * @description Private registry configuration for an organization + */ + "org-private-registry-configuration": { + /** + * @description The name of the private registry configuration. + * @example MAVEN_REPOSITORY_SECRET + */ + name: string; + /** + * @description The registry type. + * @enum {string} + */ + registry_type: "maven_repository"; + /** + * @description The username to use when authenticating with the private registry. + * @example monalisa + */ + username?: string | null; + /** + * @description Which type of organization repositories have access to the private registry. + * @enum {string} + */ + visibility: "all" | "private" | "selected"; + /** Format: date-time */ + created_at: string; + /** Format: date-time */ + updated_at: string; + }; + /** + * Organization private registry + * @description Private registry configuration for an organization + */ + "org-private-registry-configuration-with-selected-repositories": { + /** + * @description The name of the private registry configuration. + * @example MAVEN_REPOSITORY_SECRET + */ + name: string; + /** + * @description The registry type. + * @enum {string} + */ + registry_type: "maven_repository"; + /** + * @description The username to use when authenticating with the private registry. + * @example monalisa + */ + username?: string; + /** + * @description Which type of organization repositories have access to the private registry. `selected` means only the repositories specified by `selected_repository_ids` can access the private registry. + * @enum {string} + */ + visibility: "all" | "private" | "selected"; + /** @description An array of repository IDs that can access the organization private registry when `visibility` is set to `selected`. */ + selected_repository_ids?: number[]; + /** Format: date-time */ + created_at: string; + /** Format: date-time */ + updated_at: string; + }; /** * Project * @description Projects are a way to organize columns and cards of work. @@ -14915,15 +16580,26 @@ export interface components { * Organization Custom Property * @description Custom property defined on an organization */ - "org-custom-property": { + "custom-property": { /** @description The name of the property */ property_name: string; + /** + * Format: uri + * @description The URL that can be used to fetch, update, or delete info about this property via the API. + */ + url?: string; + /** + * @description The source type of the property + * @example organization + * @enum {string} + */ + source_type?: "organization" | "enterprise"; /** * @description The type of the value for the property * @example single_select * @enum {string} */ - value_type: "string" | "single_select"; + value_type: "string" | "single_select" | "multi_select" | "true_false"; /** @description Whether the property is required. */ required?: boolean; /** @description Default value of the property */ @@ -14942,6 +16618,29 @@ export interface components { */ values_editable_by?: "org_actors" | "org_and_repo_actors" | null; }; + /** + * Custom Property Set Payload + * @description Custom property set payload + */ + "custom-property-set-payload": { + /** + * @description The type of the value for the property + * @example single_select + * @enum {string} + */ + value_type: "string" | "single_select" | "multi_select" | "true_false"; + /** @description Whether the property is required. */ + required?: boolean; + /** @description Default value of the property */ + 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. + */ + allowed_values?: string[] | null; + }; /** * Custom Property Value * @description Custom property name and associated value @@ -14972,6 +16671,7 @@ export interface components { */ "nullable-repository": { /** + * Format: int64 * @description Unique identifier of the repository * @example 42 */ @@ -15263,7 +16963,7 @@ export interface components { 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. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -15347,7 +17047,10 @@ export interface components { * @description Full Repository */ "full-repository": { - /** @example 1296269 */ + /** + * Format: int64 + * @example 1296269 + */ id: number; /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */ node_id: string; @@ -15666,7 +17369,6 @@ export interface components { actor_id?: number | null; /** * @description The type of actor that can bypass a ruleset. - * * @enum {string} */ actor_type: @@ -15676,11 +17378,11 @@ export interface components { | "Team" | "DeployKey"; /** - * @description When the specified actor can bypass the ruleset. `pull_request` means that an actor can only bypass rules on pull requests. `pull_request` is not applicable for the `DeployKey` actor type. - * + * @description When the specified actor can bypass the ruleset. `pull_request` means that an actor can only bypass rules on pull requests. `pull_request` is not applicable for the `DeployKey` actor type. Also, `pull_request` is only applicable to branch rulesets. + * @default always * @enum {string} */ - bypass_mode: "always" | "pull_request"; + bypass_mode?: "always" | "pull_request"; }; /** * Repository ruleset conditions for ref names @@ -15727,6 +17429,11 @@ export interface components { name: string; /** @description The values to match for the repository property */ property_values: string[]; + /** + * @description The source of the repository property. Defaults to 'custom' if not specified. + * @enum {string} + */ + source?: "custom" | "system"; }; /** * Repository ruleset conditions for repository properties @@ -15742,7 +17449,10 @@ 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. + * @description Conditions for an organization ruleset. + * The branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties. + * The push rulesets conditions object does not require the `ref_name` property. + * For repository policy rulesets, the conditions object should only contain the `repository_name`, the `repository_id`, or the `repository_property`. */ "org-ruleset-conditions": | (components["schemas"]["repository-ruleset-conditions"] & @@ -15787,6 +17497,36 @@ export interface components { /** @enum {string} */ type: "required_linear_history"; }; + /** + * merge_queue + * @description Merges must be performed via a merge queue. + */ + "repository-rule-merge-queue": { + /** @enum {string} */ + type: "merge_queue"; + parameters?: { + /** @description Maximum time for a required status check to report a conclusion. After this much time has elapsed, checks that have not reported a conclusion will be assumed to have failed */ + check_response_timeout_minutes: number; + /** + * @description When set to ALLGREEN, the merge commit created by merge queue for each PR in the group must pass all required checks to merge. When set to HEADGREEN, only the commit at the head of the merge group, i.e. the commit containing changes from all of the PRs in the group, must pass its required checks to merge. + * @enum {string} + */ + grouping_strategy: "ALLGREEN" | "HEADGREEN"; + /** @description Limit the number of queued pull requests requesting checks and workflow runs at the same time. */ + max_entries_to_build: number; + /** @description The maximum number of PRs that will be merged together in a group. */ + max_entries_to_merge: number; + /** + * @description Method to use when merging changes from queued pull requests. + * @enum {string} + */ + merge_method: "MERGE" | "SQUASH" | "REBASE"; + /** @description The minimum number of PRs that will be merged together in a group. */ + min_entries_to_merge: number; + /** @description The time merge queue should wait after the first PR is added to the queue for the minimum group size to be met. After this time has elapsed, the minimum group size will be ignored and a smaller group will be merged. */ + min_entries_to_merge_wait_minutes: number; + }; + }; /** * required_deployments * @description Choose which environments must be successfully deployed to before refs can be pushed into a ref that matches this rule. @@ -15807,6 +17547,18 @@ export interface components { /** @enum {string} */ type: "required_signatures"; }; + /** + * RequiredReviewerConfiguration + * @description A reviewing team, and file patterns describing which files they must approve changes to. + */ + "repository-rule-params-required-reviewer-configuration": { + /** @description Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use the same syntax as `.gitignore` files. */ + file_patterns: string[]; + /** @description Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional. */ + minimum_approvals: number; + /** @description Node ID of the team which must review changes to matching files. */ + reviewer_id: string; + }; /** * pull_request * @description Require all commits be made to a non-target branch and submitted via a pull request before they can be merged. @@ -15815,6 +17567,8 @@ export interface components { /** @enum {string} */ type: "pull_request"; parameters?: { + /** @description When merging pull requests, you can allow any combination of merge commits, squashing, or rebasing. At least one option must be enabled. */ + allowed_merge_methods?: string[]; /** @description New, reviewable commits pushed will dismiss previous pull request review approvals. */ dismiss_stale_reviews_on_push: boolean; /** @description Require an approving review in pull requests that modify files that have a designated code owner. */ @@ -15845,6 +17599,8 @@ export interface components { /** @enum {string} */ type: "required_status_checks"; parameters?: { + /** @description Allow repositories and branches to be created if a check would otherwise prohibit it. */ + do_not_enforce_on_create?: boolean; /** @description Status checks that are required. */ required_status_checks: components["schemas"]["repository-rule-params-status-check-configuration"][]; /** @description Whether pull requests targeting a matching branch must be tested with the latest code. This setting will not take effect unless at least one status check is enabled. */ @@ -15996,6 +17752,8 @@ export interface components { /** @enum {string} */ type: "workflows"; parameters?: { + /** @description Allow repositories and branches to be created if a check would otherwise prohibit it. */ + do_not_enforce_on_create?: boolean; /** @description Workflows that must pass for this rule to pass. */ workflows: components["schemas"]["repository-rule-params-workflow-file-reference"][]; }; @@ -16023,6 +17781,18 @@ export interface components { /** @description The name of a code scanning tool */ tool: string; }; + /** + * code_scanning + * @description Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated. + */ + "repository-rule-code-scanning": { + /** @enum {string} */ + type: "code_scanning"; + parameters?: { + /** @description Tools that must provide code scanning results for this rule to pass. */ + code_scanning_tools: components["schemas"]["repository-rule-params-code-scanning-tool"][]; + }; + }; /** * Repository Rule * @description A repository rule. @@ -16032,6 +17802,7 @@ export interface components { | components["schemas"]["repository-rule-update"] | components["schemas"]["repository-rule-deletion"] | components["schemas"]["repository-rule-required-linear-history"] + | components["schemas"]["repository-rule-merge-queue"] | components["schemas"]["repository-rule-required-deployments"] | components["schemas"]["repository-rule-required-signatures"] | components["schemas"]["repository-rule-pull-request"] @@ -16074,7 +17845,8 @@ export interface components { max_file_size: number; }; } - | components["schemas"]["repository-rule-workflows"]; + | components["schemas"]["repository-rule-workflows"] + | components["schemas"]["repository-rule-code-scanning"]; /** * Repository ruleset * @description A set of rules to apply when specified conditions are met. @@ -16086,16 +17858,14 @@ export interface components { name: string; /** * @description The target of the ruleset - * - * **Note**: The `push` target is in beta and is subject to change. * @enum {string} */ - target?: "branch" | "tag" | "push"; + target?: "branch" | "tag" | "push" | "repository"; /** * @description The type of the source of the ruleset * @enum {string} */ - source_type?: "Repository" | "Organization"; + source_type?: "Repository" | "Organization" | "Enterprise"; /** @description The name of the source */ source: string; enforcement: components["schemas"]["repository-rule-enforcement"]; @@ -16116,7 +17886,7 @@ export interface components { html?: { /** @description The html URL of the ruleset */ href?: string; - }; + } | null; }; conditions?: | ( @@ -16165,7 +17935,7 @@ export interface components { * @description The result of the rule evaluations for rules with the `active` and `evaluate` enforcement statuses, demonstrating whether rules would pass or fail if all rules in the rule suite were `active`. * @enum {string} */ - evaluation_result?: "pass" | "fail"; + evaluation_result?: "pass" | "fail" | "bypass"; }[]; /** * Rule Suite @@ -16199,10 +17969,10 @@ export interface components { */ result?: "pass" | "fail" | "bypass"; /** - * @description The result of the rule evaluations for rules with the `active` and `evaluate` enforcement statuses, demonstrating whether rules would pass or fail if all rules in the rule suite were `active`. - * @enum {string} + * @description The result of the rule evaluations for rules with the `active` and `evaluate` enforcement statuses, demonstrating whether rules would pass or fail if all rules in the rule suite were `active`. Null if no rules with `evaluate` enforcement status were run. + * @enum {string|null} */ - evaluation_result?: "pass" | "fail"; + evaluation_result?: "pass" | "fail" | "bypass" | null; /** @description Details on the evaluated rules. */ rule_evaluations?: { rule_source?: { @@ -16225,8 +17995,8 @@ export interface components { result?: "pass" | "fail"; /** @description The type of rule. */ rule_type?: string; - /** @description Any associated details with the rule evaluation. */ - details?: string; + /** @description The detailed failure message for the rule. Null if the rule passed. */ + details?: string | null; }[]; }; /** @description A product affected by the vulnerability detailed in a repository security advisory. */ @@ -16335,6 +18105,7 @@ export interface components { /** @description The CVSS score. */ score: number | null; } | null; + cvss_severities?: components["schemas"]["cvss-severities"]; cwes: | readonly { /** @description The Common Weakness Enumeration (CWE) identifier. */ @@ -16362,69 +18133,6 @@ export interface components { /** @description A temporary private fork of the advisory's repository for collaborating on a fix. */ private_fork: components["schemas"]["simple-repository"] | null; }; - /** - * Team Simple - * @description Groups of organization members that gives permissions on specified repositories. - */ - "team-simple": { - /** - * @description Unique identifier of the team - * @example 1 - */ - id: number; - /** @example MDQ6VGVhbTE= */ - node_id: string; - /** - * Format: uri - * @description URL for the team - * @example https://api.github.com/organizations/1/team/1 - */ - url: string; - /** @example https://api.github.com/organizations/1/team/1/members{/member} */ - members_url: string; - /** - * @description Name of the team - * @example Justice League - */ - name: string; - /** - * @description Description of the team - * @example A great team. - */ - description: string | null; - /** - * @description Permission that the team will have for its repositories - * @example admin - */ - permission: string; - /** - * @description The level of privacy this team should have - * @example closed - */ - privacy?: string; - /** - * @description The notification setting the team has set - * @example notifications_enabled - */ - notification_setting?: string; - /** - * Format: uri - * @example https://github.com/orgs/rails/teams/core - */ - html_url: string; - /** - * Format: uri - * @example https://api.github.com/organizations/1/team/1/repos - */ - repositories_url: string; - /** @example justice-league */ - slug: string; - /** - * @description Distinguished Name (DN) that team maps to within LDAP environment - * @example uid=example,ou=users,dc=github,dc=com - */ - ldap_dn?: string; - }; "actions-billing-usage": { /** @description The sum of the free and paid GitHub Actions minutes used. */ total_minutes_used: number; @@ -17215,6 +18923,7 @@ export interface components { */ url: string; /** + * Format: int64 * @description The project card's ID * @example 42 */ @@ -17331,6 +19040,7 @@ export interface components { actions_runner_registration?: components["schemas"]["rate-limit"]; scim?: components["schemas"]["rate-limit"]; dependency_snapshots?: components["schemas"]["rate-limit"]; + code_scanning_autofix?: components["schemas"]["rate-limit"]; }; rate: components["schemas"]["rate-limit"]; }; @@ -17647,6 +19357,7 @@ export interface components { }; /** Pull Request Minimal */ "pull-request-minimal": { + /** Format: int64 */ id: number; number: number; url: string; @@ -17654,6 +19365,7 @@ export interface components { ref: string; sha: string; repo: { + /** Format: int64 */ id: number; url: string; name: string; @@ -17663,6 +19375,7 @@ export interface components { ref: string; sha: string; repo: { + /** Format: int64 */ id: number; url: string; name: string; @@ -17934,6 +19647,7 @@ export interface components { "pending-deployment": { environment: { /** + * Format: int64 * @description The id of the environment. * @example 56780428 */ @@ -17985,6 +19699,7 @@ export interface components { */ url: string; /** + * Format: int64 * @description Unique identifier of the deployment * @example 42 */ @@ -18320,6 +20035,7 @@ export interface components { apps_url: string; users: { login?: string; + /** Format: int64 */ id?: number; node_id?: string; avatar_url?: string; @@ -18337,6 +20053,7 @@ export interface components { received_events_url?: string; type?: string; site_admin?: boolean; + user_view_type?: string; }[]; teams: { id?: number; @@ -18392,8 +20109,11 @@ export interface components { type?: string; /** @example false */ site_admin?: boolean; + /** @example public */ + user_view_type?: string; }; name?: string; + client_id?: string; description?: string; external_url?: string; html_url?: string; @@ -18492,6 +20212,7 @@ export interface components { reason: string; payload: string | null; signature: string | null; + verified_at?: string | null; }; /** * Diff Entry @@ -18587,8 +20308,14 @@ export interface components { }; verification?: components["schemas"]["verification"]; }; - author: components["schemas"]["nullable-simple-user"]; - committer: components["schemas"]["nullable-simple-user"]; + author: + | components["schemas"]["simple-user"] + | components["schemas"]["empty-object"] + | null; + committer: + | components["schemas"]["simple-user"] + | components["schemas"]["empty-object"] + | null; parents: { /** @example 7638417db6d59f3c431d3e1f261cc637155684cd */ sha: string; @@ -18806,6 +20533,7 @@ export interface components { */ "check-run": { /** + * Format: int64 * @description The id of the check. * @example 21 */ @@ -18963,7 +20691,10 @@ export interface components { * @description A suite of checks performed on the code of a given code change */ "check-suite": { - /** @example 5 */ + /** + * Format: int64 + * @example 5 + */ id: number; /** @example MDEwOkNoZWNrU3VpdGU1 */ node_id: string; @@ -19068,7 +20799,7 @@ export interface components { security_severity_level?: "low" | "medium" | "high" | "critical" | null; /** @description A short description of the rule used to detect the alert. */ description?: string; - /** @description description of the rule used to detect the alert. */ + /** @description A description of the rule used to detect the alert. */ full_description?: string; /** @description A set of tags applicable for the rule. */ tags?: string[] | null; @@ -19099,6 +20830,40 @@ export interface components { * @enum {string} */ "code-scanning-alert-set-state": "open" | "dismissed"; + /** + * @description The status of an autofix. + * @enum {string} + */ + "code-scanning-autofix-status": + | "pending" + | "error" + | "success" + | "outdated"; + /** @description The description of an autofix. */ + "code-scanning-autofix-description": string | null; + /** + * Format: date-time + * @description The start time of an autofix in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + readonly "code-scanning-autofix-started-at": string; + "code-scanning-autofix": { + status: components["schemas"]["code-scanning-autofix-status"]; + description: components["schemas"]["code-scanning-autofix-description"]; + started_at: components["schemas"]["code-scanning-autofix-started-at"]; + }; + /** @description Commit an autofix for a code scanning alert */ + "code-scanning-autofix-commits": { + /** @description The Git reference of target branch for the commit. Branch needs to already exist. For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. */ + target_ref?: string; + /** @description Commit message to be used. */ + message?: string; + } | null; + "code-scanning-autofix-commits-response": { + /** @description The Git reference of target branch for the commit. For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. */ + target_ref?: string; + /** @description SHA of commit with autofix. */ + sha?: string; + }; /** * @description An identifier for the upload. * @example 6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53 @@ -19193,6 +20958,150 @@ export interface components { /** @description The commit SHA of the repository at the time the CodeQL database was created. */ commit_oid?: string | null; }; + /** + * @description The language targeted by the CodeQL query + * @enum {string} + */ + "code-scanning-variant-analysis-language": + | "cpp" + | "csharp" + | "go" + | "java" + | "javascript" + | "python" + | "ruby" + | "swift"; + /** + * Repository Identifier + * @description Repository Identifier + */ + "code-scanning-variant-analysis-repository": { + /** + * @description A unique identifier of the repository. + * @example 1296269 + */ + id: number; + /** + * @description The name of the repository. + * @example Hello-World + */ + name: string; + /** + * @description The full, globally unique, name of the repository. + * @example octocat/Hello-World + */ + full_name: string; + /** @description Whether the repository is private. */ + private: boolean; + /** @example 80 */ + stargazers_count: number; + /** + * Format: date-time + * @example 2011-01-26T19:14:43Z + */ + updated_at: string | null; + }; + /** + * @description The new status of the CodeQL variant analysis repository task. + * @enum {string} + */ + "code-scanning-variant-analysis-status": + | "pending" + | "in_progress" + | "succeeded" + | "failed" + | "canceled" + | "timed_out"; + "code-scanning-variant-analysis-skipped-repo-group": { + /** + * @description The total number of repositories that were skipped for this reason. + * @example 2 + */ + repository_count: number; + /** @description A list of repositories that were skipped. This list may not include all repositories that were skipped. This is only available when the repository was found and the user has access to it. */ + repositories: components["schemas"]["code-scanning-variant-analysis-repository"][]; + }; + /** + * Variant Analysis + * @description A run of a CodeQL query against one or more repositories. + */ + "code-scanning-variant-analysis": { + /** @description The ID of the variant analysis. */ + id: number; + controller_repo: components["schemas"]["simple-repository"]; + actor: components["schemas"]["simple-user"]; + query_language: components["schemas"]["code-scanning-variant-analysis-language"]; + /** @description The download url for the query pack. */ + query_pack_url: string; + /** + * Format: date-time + * @description The date and time at which the variant analysis was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. + */ + created_at?: string; + /** + * Format: date-time + * @description The date and time at which the variant analysis was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. + */ + updated_at?: string; + /** + * Format: date-time + * @description The date and time at which the variant analysis was completed, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. Will be null if the variant analysis has not yet completed or this information is not available. + */ + completed_at?: string | null; + /** @enum {string} */ + status: "in_progress" | "succeeded" | "failed" | "cancelled"; + /** @description The GitHub Actions workflow run used to execute this variant analysis. This is only available if the workflow run has started. */ + actions_workflow_run_id?: number; + /** + * @description The reason for a failure of the variant analysis. This is only available if the variant analysis has failed. + * @enum {string} + */ + failure_reason?: + | "no_repos_queried" + | "actions_workflow_run_failed" + | "internal_error"; + scanned_repositories?: { + repository: components["schemas"]["code-scanning-variant-analysis-repository"]; + analysis_status: components["schemas"]["code-scanning-variant-analysis-status"]; + /** @description The number of results in the case of a successful analysis. This is only available for successful analyses. */ + result_count?: number; + /** @description The size of the artifact. This is only available for successful analyses. */ + artifact_size_in_bytes?: number; + /** @description The reason of the failure of this repo task. This is only available if the repository task has failed. */ + failure_message?: string; + }[]; + /** @description Information about repositories that were skipped from processing. This information is only available to the user that initiated the variant analysis. */ + skipped_repositories?: { + access_mismatch_repos: components["schemas"]["code-scanning-variant-analysis-skipped-repo-group"]; + not_found_repos: { + /** + * @description The total number of repositories that were skipped for this reason. + * @example 2 + */ + repository_count: number; + /** @description A list of full repository names that were skipped. This list may not include all repositories that were skipped. */ + repository_full_names: string[]; + }; + no_codeql_db_repos: components["schemas"]["code-scanning-variant-analysis-skipped-repo-group"]; + over_limit_repos: components["schemas"]["code-scanning-variant-analysis-skipped-repo-group"]; + }; + }; + "code-scanning-variant-analysis-repo-task": { + repository: components["schemas"]["simple-repository"]; + analysis_status: components["schemas"]["code-scanning-variant-analysis-status"]; + /** @description The size of the artifact. This is only available for successful analyses. */ + artifact_size_in_bytes?: number; + /** @description The number of results in the case of a successful analysis. This is only available for successful analyses. */ + result_count?: number; + /** @description The reason of the failure of this repo task. This is only available if the repository task has failed. */ + failure_message?: string; + /** @description The SHA of the commit the CodeQL database was built against. This is only available for successful analyses. */ + database_commit_sha?: string; + /** @description The source location prefix to use. This is only available for successful analyses. */ + source_location_prefix?: string; + /** @description The URL of the artifact. This is only available for successful analyses. */ + artifact_url?: string; + }; /** @description Configuration for code scanning default setup. */ "code-scanning-default-setup": { /** @@ -19202,6 +21111,7 @@ export interface components { state?: "configured" | "not-configured"; /** @description Languages to be analyzed. */ languages?: ( + | "actions" | "c-cpp" | "csharp" | "go" @@ -19213,6 +21123,16 @@ export interface components { | "typescript" | "swift" )[]; + /** + * @description Runner type to be used. + * @enum {string|null} + */ + runner_type?: "standard" | "labeled" | null; + /** + * @description Runner label to be used if the runner type is labeled. + * @example code-scanning + */ + runner_label?: string | null; /** * @description CodeQL query suite to be used. * @enum {string} @@ -19237,6 +21157,16 @@ export interface components { * @enum {string} */ state?: "configured" | "not-configured"; + /** + * @description Runner type to be used. + * @enum {string} + */ + runner_type?: "standard" | "labeled"; + /** + * @description Runner label to be used if the runner type is labeled. + * @example code-scanning + */ + runner_label?: string | null; /** * @description CodeQL query suite to be used. * @enum {string} @@ -19244,6 +21174,7 @@ export interface components { query_suite?: "default" | "extended"; /** @description CodeQL languages to be analyzed. */ languages?: ( + | "actions" | "c-cpp" | "csharp" | "go" @@ -19294,6 +21225,23 @@ export interface components { /** @description Any errors that ocurred during processing of the delivery. */ errors?: readonly string[] | null; }; + /** @description Code security configuration associated with a repository and attachment status */ + "code-security-configuration-for-repository": { + /** + * @description The attachment status of the code security configuration on the repository. + * @enum {string} + */ + status?: + | "attached" + | "attaching" + | "detached" + | "removed" + | "enforced" + | "failed" + | "updating" + | "removed_by_enterprise"; + configuration?: components["schemas"]["code-security-configuration"]; + }; /** * CODEOWNERS errors * @description A list of errors found in a repo's CODEOWNERS file @@ -19415,7 +21363,10 @@ export interface components { collaborator: { /** @example octocat */ login: string; - /** @example 1 */ + /** + * Format: int64 + * @example 1 + */ id: number; email?: string | null; name?: string | null; @@ -19483,6 +21434,8 @@ export interface components { }; /** @example admin */ role_name: string; + /** @example public */ + user_view_type?: string; }; /** * Repository Invitation @@ -19490,6 +21443,7 @@ export interface components { */ "repository-invitation": { /** + * Format: int64 * @description Unique identifier of the repository invitation. * @example 42 */ @@ -19526,7 +21480,10 @@ export interface components { "nullable-collaborator": { /** @example octocat */ login: string; - /** @example 1 */ + /** + * Format: int64 + * @example 1 + */ id: number; email?: string | null; name?: string | null; @@ -19594,6 +21551,8 @@ export interface components { }; /** @example admin */ role_name: string; + /** @example public */ + user_view_type?: string; } | null; /** * Repository Collaborator Permission @@ -19674,7 +21633,10 @@ export interface components { * @example https://api.github.com/repos/octocat/Hello-World/pulls/1347 */ url: string; - /** @example 1 */ + /** + * Format: int64 + * @example 1 + */ id: number; /** @example MDExOlB1bGxSZXF1ZXN0MQ== */ node_id: string; @@ -19964,6 +21926,7 @@ export interface components { name: string; path: string; sha: string; + content?: string; /** Format: uri */ url: string; /** Format: uri */ @@ -19977,7 +21940,6 @@ export interface components { size: number; name: string; path: string; - content?: string; sha: string; /** Format: uri */ url: string; @@ -20178,6 +22140,23 @@ export interface components { reason?: string; signature?: string | null; payload?: string | null; + verified_at?: string | null; + }; + }; + }; + /** @description The ID of the push protection bypass placeholder. This value is returned on any push protected routes. */ + "secret-scanning-push-protection-bypass-placeholder-id": string; + /** @description Repository rule violation was detected */ + "repository-rule-violation-error": { + message?: string; + documentation_url?: string; + status?: string; + metadata?: { + secret_scanning?: { + bypass_placeholders?: { + placeholder_id?: components["schemas"]["secret-scanning-push-protection-bypass-placeholder-id"]; + token_type?: string; + }[]; }; }; }; @@ -20215,6 +22194,7 @@ export interface components { contributions: number; email?: string; name?: string; + user_view_type?: string; }; /** @description A Dependabot alert. */ "dependabot-alert": { @@ -20327,6 +22307,11 @@ export interface components { * @example SPDX-2.3 */ spdxVersion: string; + /** + * @description An optional comment about the SPDX document. + * @example Exact versions could not be resolved for some packages. For more information: https://docs.github.com/en/code-security/supply-chain-security/understanding-your-software-supply-chain/ + */ + comment?: string; creationInfo: { /** * @description The date and time the SPDX document was created. @@ -20346,11 +22331,9 @@ export interface components { * @example CC0-1.0 */ dataLicense: string; - /** @description The name of the repository that the SPDX document describes. */ - documentDescribes: string[]; /** * @description The namespace for the SPDX document. - * @example https://github.com/example/dependency_graph/sbom-123 + * @example https://spdx.org/spdxdocs/protobom/15e41dd2-f961-4f4d-b8dc-f8f57ad70d57 */ documentNamespace: string; packages: { @@ -20361,7 +22344,7 @@ export interface components { SPDXID?: string; /** * @description The name of the package. - * @example rubygems:github/github + * @example github/github */ name?: string; /** @@ -20398,6 +22381,11 @@ export interface components { * @example NOASSERTION */ supplier?: string; + /** + * @description The copyright holders of the package, and any dates present with those notices, if available. + * @example Copyright (c) 1985 GitHub.com + */ + copyrightText?: string; externalRefs?: { /** * @description The category of reference to an external resource this reference refers to. @@ -20416,6 +22404,17 @@ export interface components { referenceType: string; }[]; }[]; + relationships?: { + /** + * @description The type of relationship between the two SPDX elements. + * @example DEPENDS_ON + */ + relationshipType?: string; + /** @description The SPDX identifier of the package that is the source of the relationship. */ + spdxElementId?: string; + /** @description The SPDX identifier of the package that is the target of the relationship. */ + relatedSpdxElement?: string; + }[]; }; }; /** @@ -20543,7 +22542,10 @@ export interface components { * @example https://api.github.com/repos/octocat/example/deployments/42/statuses/1 */ url: string; - /** @example 1 */ + /** + * Format: int64 + * @example 1 + */ id: number; /** @example MDE2OkRlcGxveW1lbnRTdGF0dXMx */ node_id: string; @@ -20575,7 +22577,7 @@ export interface components { environment?: string; /** * Format: uri - * @description Deprecated: the URL to associate with this status. + * @description Closing down notice: the URL to associate with this status. * @default * @example https://example.com/deployment/42/output */ @@ -20634,6 +22636,7 @@ export interface components { */ environment: { /** + * Format: int64 * @description The id of the environment. * @example 56780428 */ @@ -20911,6 +22914,7 @@ export interface components { reason: string; signature: string | null; payload: string | null; + verified_at?: string | null; }; /** Format: uri */ html_url: string; @@ -21293,6 +23297,7 @@ export interface components { performed_via_github_app?: components["schemas"]["nullable-integration"]; author_association: components["schemas"]["author-association"]; reactions?: components["schemas"]["reaction-rollup"]; + sub_issues_summary?: components["schemas"]["sub-issues-summary"]; } | null; /** * Issue Event Label @@ -21710,6 +23715,7 @@ export interface components { label: { /** * Format: int64 + * @description Unique identifier for the label. * @example 208045946 */ id: number; @@ -21726,14 +23732,20 @@ export interface components { * @example bug */ name: string; - /** @example Something isn't working */ + /** + * @description Optional description of the label, such as its purpose. + * @example Something isn't working + */ description: string | null; /** * @description 6-character hex code, without the leading #, identifying the color * @example FFFFFF */ color: string; - /** @example true */ + /** + * @description Whether this label comes by default in a new repository. + * @example true + */ default: boolean; }; /** @@ -21879,6 +23891,7 @@ export interface components { reason: string; signature: string | null; payload: string | null; + verified_at?: string | null; }; /** Format: uri */ html_url: string; @@ -21944,11 +23957,13 @@ export interface components { */ url: string; /** + * Format: int64 * @description The ID of the pull request review to which the comment belongs. * @example 42 */ pull_request_review_id: number | null; /** + * Format: int64 * @description The ID of the pull request review comment. * @example 1 */ @@ -21969,12 +23984,12 @@ export interface components { */ path: string; /** - * @description The line index in the diff to which the comment applies. This field is deprecated; use `line` instead. + * @description The line index in the diff to which the comment applies. This field is closing down; use `line` instead. * @example 1 */ position?: number; /** - * @description The index of the original line in the diff to which the comment applies. This field is deprecated; use `original_line` instead. + * @description The index of the original line in the diff to which the comment applies. This field is closing down; use `original_line` instead. * @example 4 */ original_position?: number; @@ -22196,6 +24211,7 @@ export interface components { read_only: boolean; added_by?: string | null; last_used?: string | null; + enabled?: boolean; }; /** * Language @@ -22567,7 +24583,10 @@ export interface components { * @example https://api.github.com/repos/octocat/Hello-World/pulls/1347 */ url: string; - /** @example 1 */ + /** + * Format: int64 + * @example 1 + */ id: number; /** @example MDExOlB1bGxSZXF1ZXN0MQ== */ node_id: string; @@ -22676,359 +24695,16 @@ export interface components { head: { label: string; ref: string; - repo: { - archive_url: string; - assignees_url: string; - blobs_url: string; - branches_url: string; - collaborators_url: string; - comments_url: string; - commits_url: string; - compare_url: string; - contents_url: string; - /** Format: uri */ - contributors_url: string; - /** Format: uri */ - deployments_url: string; - description: string | null; - /** Format: uri */ - downloads_url: string; - /** Format: uri */ - events_url: string; - fork: boolean; - /** Format: uri */ - forks_url: string; - full_name: string; - git_commits_url: string; - git_refs_url: string; - git_tags_url: string; - /** Format: uri */ - hooks_url: string; - /** Format: uri */ - html_url: string; - id: number; - node_id: string; - issue_comment_url: string; - issue_events_url: string; - issues_url: string; - keys_url: string; - labels_url: string; - /** Format: uri */ - languages_url: string; - /** Format: uri */ - merges_url: string; - milestones_url: string; - name: string; - notifications_url: string; - owner: { - /** Format: uri */ - avatar_url: string; - events_url: string; - /** Format: uri */ - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string | null; - /** Format: uri */ - html_url: string; - id: number; - node_id: string; - login: string; - /** Format: uri */ - organizations_url: string; - /** Format: uri */ - received_events_url: string; - /** Format: uri */ - repos_url: string; - site_admin: boolean; - starred_url: string; - /** Format: uri */ - subscriptions_url: string; - type: string; - /** Format: uri */ - url: string; - }; - private: boolean; - pulls_url: string; - releases_url: string; - /** Format: uri */ - stargazers_url: string; - statuses_url: string; - /** Format: uri */ - subscribers_url: string; - /** Format: uri */ - subscription_url: string; - /** Format: uri */ - tags_url: string; - /** Format: uri */ - teams_url: string; - trees_url: string; - /** Format: uri */ - url: string; - clone_url: string; - default_branch: string; - forks: number; - forks_count: number; - git_url: string; - has_downloads: boolean; - has_issues: boolean; - has_projects: boolean; - has_wiki: boolean; - has_pages: boolean; - has_discussions: boolean; - /** Format: uri */ - homepage: string | null; - language: string | null; - master_branch?: string; - archived: boolean; - disabled: boolean; - /** @description The repository visibility: public, private, or internal. */ - visibility?: string; - /** Format: uri */ - mirror_url: string | null; - open_issues: number; - open_issues_count: number; - permissions?: { - admin: boolean; - maintain?: boolean; - push: boolean; - triage?: boolean; - pull: boolean; - }; - temp_clone_token?: string; - allow_merge_commit?: boolean; - allow_squash_merge?: boolean; - allow_rebase_merge?: boolean; - license: { - key: string; - name: string; - /** Format: uri */ - url: string | null; - spdx_id: string | null; - node_id: string; - } | null; - /** Format: date-time */ - pushed_at: string; - size: number; - ssh_url: string; - stargazers_count: number; - /** Format: uri */ - svn_url: string; - topics?: string[]; - watchers: number; - watchers_count: number; - /** Format: date-time */ - created_at: string; - /** Format: date-time */ - updated_at: string; - allow_forking?: boolean; - is_template?: boolean; - web_commit_signoff_required?: boolean; - } | null; + repo: components["schemas"]["repository"]; sha: string; - user: { - /** Format: uri */ - avatar_url: string; - events_url: string; - /** Format: uri */ - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string | null; - /** Format: uri */ - html_url: string; - id: number; - node_id: string; - login: string; - /** Format: uri */ - organizations_url: string; - /** Format: uri */ - received_events_url: string; - /** Format: uri */ - repos_url: string; - site_admin: boolean; - starred_url: string; - /** Format: uri */ - subscriptions_url: string; - type: string; - /** Format: uri */ - url: string; - }; + user: components["schemas"]["simple-user"]; }; base: { label: string; ref: string; - repo: { - archive_url: string; - assignees_url: string; - blobs_url: string; - branches_url: string; - collaborators_url: string; - comments_url: string; - commits_url: string; - compare_url: string; - contents_url: string; - /** Format: uri */ - contributors_url: string; - /** Format: uri */ - deployments_url: string; - description: string | null; - /** Format: uri */ - downloads_url: string; - /** Format: uri */ - events_url: string; - fork: boolean; - /** Format: uri */ - forks_url: string; - full_name: string; - git_commits_url: string; - git_refs_url: string; - git_tags_url: string; - /** Format: uri */ - hooks_url: string; - /** Format: uri */ - html_url: string; - id: number; - is_template?: boolean; - node_id: string; - issue_comment_url: string; - issue_events_url: string; - issues_url: string; - keys_url: string; - labels_url: string; - /** Format: uri */ - languages_url: string; - /** Format: uri */ - merges_url: string; - milestones_url: string; - name: string; - notifications_url: string; - owner: { - /** Format: uri */ - avatar_url: string; - events_url: string; - /** Format: uri */ - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string | null; - /** Format: uri */ - html_url: string; - id: number; - node_id: string; - login: string; - /** Format: uri */ - organizations_url: string; - /** Format: uri */ - received_events_url: string; - /** Format: uri */ - repos_url: string; - site_admin: boolean; - starred_url: string; - /** Format: uri */ - subscriptions_url: string; - type: string; - /** Format: uri */ - url: string; - }; - private: boolean; - pulls_url: string; - releases_url: string; - /** Format: uri */ - stargazers_url: string; - statuses_url: string; - /** Format: uri */ - subscribers_url: string; - /** Format: uri */ - subscription_url: string; - /** Format: uri */ - tags_url: string; - /** Format: uri */ - teams_url: string; - trees_url: string; - /** Format: uri */ - url: string; - clone_url: string; - default_branch: string; - forks: number; - forks_count: number; - git_url: string; - has_downloads: boolean; - has_issues: boolean; - has_projects: boolean; - has_wiki: boolean; - has_pages: boolean; - has_discussions: boolean; - /** Format: uri */ - homepage: string | null; - language: string | null; - master_branch?: string; - archived: boolean; - disabled: boolean; - /** @description The repository visibility: public, private, or internal. */ - visibility?: string; - /** Format: uri */ - mirror_url: string | null; - open_issues: number; - open_issues_count: number; - permissions?: { - admin: boolean; - maintain?: boolean; - push: boolean; - triage?: boolean; - pull: boolean; - }; - temp_clone_token?: string; - allow_merge_commit?: boolean; - allow_squash_merge?: boolean; - allow_rebase_merge?: boolean; - license: components["schemas"]["nullable-license-simple"]; - /** Format: date-time */ - pushed_at: string; - size: number; - ssh_url: string; - stargazers_count: number; - /** Format: uri */ - svn_url: string; - topics?: string[]; - watchers: number; - watchers_count: number; - /** Format: date-time */ - created_at: string; - /** Format: date-time */ - updated_at: string; - allow_forking?: boolean; - web_commit_signoff_required?: boolean; - }; + repo: components["schemas"]["repository"]; sha: string; - user: { - /** Format: uri */ - avatar_url: string; - events_url: string; - /** Format: uri */ - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string | null; - /** Format: uri */ - html_url: string; - id: number; - node_id: string; - login: string; - /** Format: uri */ - organizations_url: string; - /** Format: uri */ - received_events_url: string; - /** Format: uri */ - repos_url: string; - site_admin: boolean; - starred_url: string; - /** Format: uri */ - subscriptions_url: string; - type: string; - /** Format: uri */ - url: string; - }; + user: components["schemas"]["simple-user"]; }; _links: { comments: components["schemas"]["link"]; @@ -23096,6 +24772,7 @@ export interface components { */ "pull-request-review": { /** + * Format: int64 * @description Unique identifier of the review * @example 42 */ @@ -23149,9 +24826,15 @@ export interface components { * @example https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 */ url: string; - /** @example 42 */ + /** + * Format: int64 + * @example 42 + */ pull_request_review_id: number | null; - /** @example 10 */ + /** + * Format: int64 + * @example 10 + */ id: number; /** @example MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw */ node_id: string; @@ -23362,6 +25045,8 @@ export interface components { components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-required-linear-history"] & components["schemas"]["repository-rule-ruleset-info"]) + | (components["schemas"]["repository-rule-merge-queue"] & + components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-required-deployments"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-required-signatures"] & @@ -23383,6 +25068,8 @@ export interface components { | (components["schemas"]["repository-rule-tag-name-pattern"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-workflows"] & + components["schemas"]["repository-rule-ruleset-info"]) + | (components["schemas"]["repository-rule-code-scanning"] & components["schemas"]["repository-rule-ruleset-info"]); "secret-scanning-alert": { number?: components["schemas"]["alert-number"]; @@ -23409,7 +25096,7 @@ export interface components { 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)." + * For a list of built-in patterns, see "[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)." */ secret_type_display_name?: string; /** @description The secret that was detected. */ @@ -23422,11 +25109,25 @@ export interface components { * @description The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ push_protection_bypassed_at?: string | null; + push_protection_bypass_request_reviewer?: components["schemas"]["nullable-simple-user"]; + /** @description An optional comment when reviewing a push protection bypass. */ + push_protection_bypass_request_reviewer_comment?: string | null; + /** @description An optional comment when requesting a push protection bypass. */ + push_protection_bypass_request_comment?: string | null; + /** + * Format: uri + * @description The URL to a push protection bypass request. + */ + push_protection_bypass_request_html_url?: string | null; /** * @description The token status as of the latest validity check. * @enum {string} */ validity?: "active" | "inactive" | "unknown"; + /** @description Whether the detected secret was publicly leaked. */ + publicly_leaked?: boolean | null; + /** @description Whether the detected secret was found in multiple repositories under the same organization or enterprise. */ + multi_repo?: boolean | null; }; /** @description An optional comment when closing an alert. Cannot be updated or deleted. Must be `null` when changing `state` to `open`. */ "secret-scanning-alert-resolution-comment": string | null; @@ -23555,7 +25256,7 @@ export interface components { /** * Format: uri * @description The API URL to get the pull request where the secret was detected. - * @example https://api.github.com/repos/octocat/Hello-World/pull/2846 + * @example https://api.github.com/repos/octocat/Hello-World/pulls/2846 */ pull_request_title_url: string; }; @@ -23564,7 +25265,7 @@ export interface components { /** * Format: uri * @description The API URL to get the pull request where the secret was detected. - * @example https://api.github.com/repos/octocat/Hello-World/pull/2846 + * @example https://api.github.com/repos/octocat/Hello-World/pulls/2846 */ pull_request_body_url: string; }; @@ -23630,6 +25331,52 @@ export interface components { | components["schemas"]["secret-scanning-location-pull-request-review"] | components["schemas"]["secret-scanning-location-pull-request-review-comment"]; }; + /** + * @description The reason for bypassing push protection. + * @enum {string} + */ + "secret-scanning-push-protection-bypass-reason": + | "false_positive" + | "used_in_tests" + | "will_fix_later"; + "secret-scanning-push-protection-bypass": { + reason?: components["schemas"]["secret-scanning-push-protection-bypass-reason"]; + /** + * Format: date-time + * @description The time that the bypass will expire in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + expire_at?: string | null; + /** @description The token type this bypass is for. */ + token_type?: string; + }; + /** @description Information on a single scan performed by secret scanning on the repository */ + "secret-scanning-scan": { + /** @description The type of scan */ + type?: string; + /** @description The state of the scan. Either "completed", "running", or "pending" */ + status?: string; + /** + * Format: date-time + * @description The time that the scan was completed. Empty if the scan is running + */ + completed_at?: string | null; + /** + * Format: date-time + * @description The time that the scan was started. Empty if the scan is pending + */ + started_at?: string | null; + }; + "secret-scanning-scan-history": { + incremental_scans?: components["schemas"]["secret-scanning-scan"][]; + pattern_update_scans?: components["schemas"]["secret-scanning-scan"][]; + backfill_scans?: components["schemas"]["secret-scanning-scan"][]; + custom_pattern_backfill_scans?: (components["schemas"]["secret-scanning-scan"] & { + /** @description Name of the custom pattern for custom pattern scans */ + pattern_name?: string; + /** @description Level at which the custom pattern is defined, one of "repository", "organization", or "enterprise" */ + pattern_scope?: string; + })[]; + }; "repository-advisory-create": { /** @description A short summary of the advisory. */ summary: string; @@ -24076,6 +25823,12 @@ export interface components { default?: boolean; description?: string | null; }[]; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; state: string; state_reason?: string | null; assignee: components["schemas"]["nullable-simple-user"]; @@ -24302,6 +26055,7 @@ export interface components { */ "user-search-result-item": { login: string; + /** Format: int64 */ id: number; node_id: string; /** Format: uri */ @@ -24347,6 +26101,7 @@ export interface components { company?: string | null; /** Format: date-time */ suspended_at?: string | null; + user_view_type?: string; }; /** * Private User @@ -24355,8 +26110,12 @@ export interface components { "private-user": { /** @example octocat */ login: string; - /** @example 1 */ + /** + * Format: int64 + * @example 1 + */ id: number; + user_view_type?: string; /** @example MDQ6VXNlcjE= */ node_id: string; /** @@ -24425,6 +26184,11 @@ export interface components { * @example octocat@github.com */ email: string | null; + /** + * Format: email + * @example octocat@github.com + */ + notification_email?: string | null; hireable: boolean | null; /** @example There once was... */ bio: string | null; @@ -24466,8 +26230,6 @@ export interface components { space: number; private_repos: number; }; - /** Format: date-time */ - suspended_at?: string | null; business_plus?: boolean; ldap_dn?: string; }; @@ -24566,7 +26328,10 @@ export interface components { * @description A codespace. */ "codespace-with-full-repository": { - /** @example 1 */ + /** + * Format: int64 + * @example 1 + */ id: number; /** * @description Automatically generated name of this codespace. @@ -24749,7 +26514,10 @@ export interface components { * @description A unique encryption key */ "gpg-key": { - /** @example 3 */ + /** + * Format: int64 + * @example 3 + */ id: number; /** @example Octocat's GPG Key */ name?: string | null; @@ -24789,6 +26557,7 @@ export interface components { * ] */ subkeys: { + /** Format: int64 */ id?: number; primary_key_id?: number; key_id?: string; @@ -24830,6 +26599,7 @@ export interface components { */ key: { key: string; + /** Format: int64 */ id: number; url: string; title: string; @@ -24909,6 +26679,45 @@ export interface components { starred_at: string; repo: components["schemas"]["repository"]; }; + /** + * Sigstore Bundle v0.1 + * @description Sigstore Bundle v0.1 + */ + "sigstore-bundle-0": { + mediaType?: string; + verificationMaterial?: { + x509CertificateChain?: { + certificates?: { + rawBytes?: string; + }[]; + }; + tlogEntries?: { + logIndex?: string; + logId?: { + keyId?: string; + }; + kindVersion?: { + kind?: string; + version?: string; + }; + integratedTime?: string; + inclusionPromise?: { + signedEntryTimestamp?: string; + }; + inclusionProof?: string | null; + canonicalizedBody?: string; + }[]; + timestampVerificationData?: string | null; + }; + dsseEnvelope?: { + payload?: string; + payloadType?: string; + signatures?: { + sig?: string; + keyid?: string; + }[]; + }; + }; /** * Hovercard * @description Hovercard @@ -25041,6 +26850,7 @@ export interface components { */ "repository-webhooks": { /** + * Format: int64 * @description Unique identifier of the repository * @example 42 */ @@ -25480,7 +27290,7 @@ export interface components { 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. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -25541,75 +27351,6 @@ export interface components { /** @description Whether anonymous git access is enabled for this repository */ anonymous_access_enabled?: boolean; }; - /** - * Simple User - * @description The GitHub user that triggered the event. This property is included in every webhook payload. - */ - "simple-user-webhooks": { - name?: string | null; - email?: string | null; - /** @example octocat */ - login: string; - /** @example 1 */ - id: number; - /** @example MDQ6VXNlcjE= */ - node_id: string; - /** - * Format: uri - * @example https://github.com/images/error/octocat_happy.gif - */ - avatar_url: string; - /** @example 41d064eb2195891e12d0413f63227ea7 */ - gravatar_id: string | null; - /** - * Format: uri - * @example https://api.github.com/users/octocat - */ - url: string; - /** - * Format: uri - * @example https://github.com/octocat - */ - html_url: string; - /** - * Format: uri - * @example https://api.github.com/users/octocat/followers - */ - followers_url: string; - /** @example https://api.github.com/users/octocat/following{/other_user} */ - following_url: string; - /** @example https://api.github.com/users/octocat/gists{/gist_id} */ - gists_url: string; - /** @example https://api.github.com/users/octocat/starred{/owner}{/repo} */ - starred_url: string; - /** - * Format: uri - * @example https://api.github.com/users/octocat/subscriptions - */ - subscriptions_url: string; - /** - * Format: uri - * @example https://api.github.com/users/octocat/orgs - */ - organizations_url: string; - /** - * Format: uri - * @example https://api.github.com/users/octocat/repos - */ - repos_url: string; - /** @example https://api.github.com/users/octocat/events{/privacy} */ - events_url: string; - /** - * Format: uri - * @example https://api.github.com/users/octocat/received_events - */ - received_events_url: string; - /** @example User */ - type: string; - site_admin: boolean; - /** @example "2020-07-09T00:17:55Z" */ - starred_at?: string; - }; /** * branch protection rule * @description The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) applied to branches that match the name. Binary settings are boolean. Multi-level configurations are one of `off`, `non_admins`, or `everyone`. Actor and build lists are arrays of strings. @@ -25634,6 +27375,13 @@ export interface components { | "off" | "non_admins" | "everyone"; + /** + * @description The enforcement level of the branch lock setting. `off` means the branch is not locked, `non_admins` means the branch is read-only for non_admins, and `everyone` means the branch is read-only for everyone. + * @enum {string} + */ + lock_branch_enforcement_level: "off" | "non_admins" | "everyone"; + /** @description Whether users can pull changes from upstream when the branch is locked. Set to `true` to allow users to pull changes from upstream when the branch is locked. This setting is only applicable for forks. */ + lock_allows_fork_sync?: boolean; /** @enum {string} */ merge_queue_enforcement_level: "off" | "non_admins" | "everyone"; name: string; @@ -25806,6 +27554,7 @@ export interface components { /** Format: uri */ url: string; verified: boolean; + enabled?: boolean; }; /** Workflow */ webhooks_workflow: { @@ -25844,6 +27593,7 @@ export interface components { subscriptions_url?: string; type?: string; url?: string; + user_view_type?: string; }; webhooks_reviewers: { /** User */ @@ -25913,6 +27663,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -25932,6 +27683,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; webhooks_answer: { /** @@ -25991,6 +27743,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -26010,6 +27763,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** @@ -26055,6 +27809,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; answer_html_url: string | null; /** @@ -26142,6 +27897,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -26161,7 +27917,9 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; + labels?: components["schemas"]["label"][]; }; webhooks_comment: { /** @@ -26219,6 +27977,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -26238,6 +27997,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Label */ @@ -26355,6 +28115,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -26374,6 +28135,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** @description The changes to the comment. */ @@ -26431,6 +28193,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -26467,6 +28230,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -26562,6 +28326,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -26692,6 +28457,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -26799,6 +28565,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -26833,6 +28605,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -26852,6 +28625,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** @@ -26900,6 +28674,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -26973,6 +28748,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -27009,6 +28785,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -27104,6 +28881,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -27232,6 +29010,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -27339,6 +29118,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -27373,6 +29158,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -27392,6 +29178,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** User */ @@ -27430,6 +29217,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** Marketplace Purchase */ webhooks_marketplace_purchase: { @@ -27571,6 +29359,7 @@ export interface components { */ "nullable-repository-webhooks": { /** + * Format: int64 * @description Unique identifier of the repository * @example 42 */ @@ -28010,7 +29799,7 @@ export interface components { 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. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -28117,6 +29906,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -28170,6 +29960,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -28189,6 +29980,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** @@ -28257,6 +30049,10 @@ export interface components { | null; /** @description Date and time when the request for access was created. */ created_at: string; + /** @description Unique identifier of the user's token. This field can also be found in audit log events and the organization's settings for their PAT grants. */ + token_id: number; + /** @description The name given to the user's token. This field can also be found in an organization's settings page for Active Tokens. */ + token_name: string; /** @description Whether the associated fine-grained personal access token has expired. */ token_expired: boolean; /** @description Date and time when the associated fine-grained personal access token expires. */ @@ -28312,6 +30108,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The project card's ID */ id: number; @@ -28368,6 +30165,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** Format: uri */ html_url: string; @@ -28484,6 +30282,69 @@ export interface components { */ archived_at: string | null; }; + /** + * Projects v2 Single Select Option + * @description An option for a single select field + */ + "projects-v2-single-select-option": { + id: string; + name: string; + color?: string | null; + description?: string | null; + }; + /** + * Projects v2 Iteration Setting + * @description An iteration setting for an iteration field + */ + "projects-v2-iteration-setting": { + id: string; + title: string; + duration?: number | null; + start_date?: string | null; + }; + /** + * Projects v2 Status Update + * @description An status update belonging to a project + */ + "projects-v2-status-update": { + id: number; + node_id: string; + project_node_id?: string; + creator?: components["schemas"]["simple-user"]; + /** + * Format: date-time + * @example 2022-04-28T12:00:00Z + */ + created_at: string; + /** + * Format: date-time + * @example 2022-04-28T12:00:00Z + */ + updated_at: string; + /** @enum {string|null} */ + status?: + | "INACTIVE" + | "ON_TRACK" + | "AT_RISK" + | "OFF_TRACK" + | "COMPLETE" + | null; + /** + * Format: date + * @example 2022-04-28 + */ + start_date?: string; + /** + * Format: date + * @example 2022-04-28 + */ + target_date?: string; + /** + * @description Body of the status update + * @example The project is off to a great start! + */ + body?: string | null; + }; /** @description The pull request number. */ webhooks_number: number; "pull-request-webhook": components["schemas"]["pull-request"] & { @@ -28530,7 +30391,7 @@ export interface components { */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; /** - * @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.** + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.** * @default false */ use_squash_pr_title_as_default?: boolean; @@ -28623,6 +30484,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -28719,6 +30581,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -28846,7 +30709,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -28939,6 +30805,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -29028,6 +30895,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -29047,6 +30915,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -29186,7 +31055,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -29279,6 +31151,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -29368,6 +31241,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -29387,6 +31261,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -29454,6 +31329,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Milestone @@ -29501,6 +31377,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -29709,6 +31586,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -29728,6 +31606,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** @@ -29862,6 +31741,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -29881,6 +31761,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** @description The review that was affected. */ @@ -29942,6 +31823,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -29961,6 +31843,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; webhooks_nullable_string: string | null; @@ -30067,6 +31950,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; body: string | null; /** Format: date-time */ @@ -30214,6 +32098,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; body: string | null; /** Format: date-time */ @@ -30354,6 +32239,11 @@ 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 "[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)." + */ + secret_type_display_name?: string; /** * @description The token status as of the latest validity check. * @enum {string} @@ -30367,6 +32257,20 @@ export interface components { * @description The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ push_protection_bypassed_at?: string | null; + push_protection_bypass_request_reviewer?: components["schemas"]["nullable-simple-user"]; + /** @description An optional comment when reviewing a push protection bypass. */ + push_protection_bypass_request_reviewer_comment?: string | null; + /** @description An optional comment when requesting a push protection bypass. */ + push_protection_bypass_request_comment?: string | null; + /** + * Format: uri + * @description The URL to a push protection bypass request. + */ + push_protection_bypass_request_html_url?: string | null; + /** @description Whether the detected secret was publicly leaked. */ + publicly_leaked?: boolean | null; + /** @description Whether the detected secret was found in multiple repositories in the same organization or business. */ + multi_repo?: boolean | null; }; /** @description The details of the security advisory, including summary, description, and severity. */ webhooks_security_advisory: { @@ -30374,6 +32278,7 @@ export interface components { score: number; vector_string: string | null; }; + cvss_severities?: components["schemas"]["cvss-severities"]; cwes: { cwe_id: string; name: string; @@ -30426,6 +32331,7 @@ export interface components { subscriptions_url?: string; type?: string; url?: string; + user_view_type?: string; }; node_id: string; privacy_level: string; @@ -30465,6 +32371,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** User */ sponsorable: { @@ -30502,6 +32409,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Sponsorship Tier @@ -30615,7 +32523,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** branch protection configuration enabled event */ "webhook-branch-protection-configuration-enabled": { @@ -30625,7 +32533,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** branch protection rule created event */ "webhook-branch-protection-rule-created": { @@ -30636,7 +32544,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; rule: components["schemas"]["webhooks_rule"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** branch protection rule deleted event */ "webhook-branch-protection-rule-deleted": { @@ -30647,7 +32555,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; rule: components["schemas"]["webhooks_rule"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** branch protection rule edited event */ "webhook-branch-protection-rule-edited": { @@ -30671,6 +32579,20 @@ export interface components { /** @enum {string} */ from: "off" | "non_admins" | "everyone"; }; + lock_branch_enforcement_level?: { + /** @enum {string} */ + from: "off" | "non_admins" | "everyone"; + }; + lock_allows_fork_sync?: { + from: boolean | null; + }; + pull_request_reviews_enforcement_level?: { + /** @enum {string} */ + from: "off" | "non_admins" | "everyone"; + }; + require_last_push_approval?: { + from: boolean | null; + }; required_status_checks?: { from: string[]; }; @@ -30684,7 +32606,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; rule: components["schemas"]["webhooks_rule"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Check Run Completed Event */ "webhook-check-run-completed": { @@ -30694,7 +32616,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** * Check Run Completed Event @@ -30712,7 +32634,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** * Check Run Created Event @@ -30735,7 +32657,7 @@ export interface components { /** @description The integrator reference of the action requested by the user. */ identifier?: string; }; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** * Check Run Requested Action Event @@ -30753,7 +32675,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** * Check Run Re-Requested Event @@ -30839,6 +32761,8 @@ export interface components { html_url: string; /** @description Unique identifier of the GitHub app */ id: number | null; + /** @description The client ID of the GitHub app */ + client_id?: string | null; /** @description The name of the GitHub app */ name: string; node_id: string; @@ -30878,6 +32802,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -31071,7 +32996,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** check_suite requested event */ "webhook-check-suite-requested": { @@ -31150,6 +33075,8 @@ export interface components { html_url: string; /** @description Unique identifier of the GitHub app */ id: number | null; + /** @description Client ID of the GitHub app */ + client_id?: string | null; /** @description The name of the GitHub app */ name: string; node_id: string; @@ -31189,6 +33116,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -31375,7 +33303,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** check_suite rerequested event */ "webhook-check-suite-rerequested": { @@ -31449,6 +33377,8 @@ export interface components { html_url: string; /** @description Unique identifier of the GitHub app */ id: number | null; + /** @description The Client ID for the GitHub app */ + client_id?: string | null; /** @description The name of the GitHub app */ name: string; node_id: string; @@ -31488,6 +33418,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -31673,7 +33604,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** code_scanning_alert appeared_in_branch event */ "webhook-code-scanning-alert-appeared-in-branch": { @@ -31727,6 +33658,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The reason for dismissing or closing the alert. @@ -31803,7 +33735,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; ref: components["schemas"]["webhooks_code_scanning_ref"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** code_scanning_alert closed_by_user event */ "webhook-code-scanning-alert-closed-by-user": { @@ -31857,6 +33789,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The reason for dismissing or closing the alert. @@ -31940,7 +33873,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; ref: components["schemas"]["webhooks_code_scanning_ref"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** code_scanning_alert created event */ "webhook-code-scanning-alert-created": { @@ -32015,9 +33948,9 @@ export interface components { }; /** * @description State of a code scanning alert. - * @enum {string} + * @enum {string|null} */ - state: "open" | "dismissed"; + state: "open" | "dismissed" | null; tool: { guid?: string | null; /** @description The name of the tool used to generate the code scanning analysis alert. */ @@ -32035,7 +33968,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; ref: components["schemas"]["webhooks_code_scanning_ref"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** code_scanning_alert fixed event */ "webhook-code-scanning-alert-fixed": { @@ -32089,6 +34022,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The reason for dismissing or closing the alert. @@ -32174,7 +34108,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; ref: components["schemas"]["webhooks_code_scanning_ref"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** code_scanning_alert reopened event */ "webhook-code-scanning-alert-reopened": { @@ -32267,7 +34201,7 @@ export interface components { /** @description The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. */ ref: string | null; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** code_scanning_alert reopened_by_user event */ "webhook-code-scanning-alert-reopened-by-user": { @@ -32351,7 +34285,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; ref: components["schemas"]["webhooks_code_scanning_ref"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** commit_comment created event */ "webhook-commit-comment-created": { @@ -32360,7 +34294,7 @@ export interface components { * @enum {string} */ action: "created"; - /** @description The [commit comment](https://docs.github.com/rest/commits/comments#get-a-commit-comment) resource. */ + /** @description The [commit comment](${externalDocsUpapp/api/description/components/schemas/webhooks/issue-comment-created.yamlrl}/rest/commits/comments#get-a-commit-comment) resource. */ comment: { /** * AuthorAssociation @@ -32427,6 +34361,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -32446,13 +34381,14 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** create event */ "webhook-create": { @@ -32471,17 +34407,17 @@ export interface components { */ ref_type: "tag" | "branch"; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** custom property created event */ "webhook-custom-property-created": { /** @enum {string} */ action: "created"; - definition: components["schemas"]["org-custom-property"]; + definition: components["schemas"]["custom-property"]; enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; - organization: components["schemas"]["organization-simple-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** custom property deleted event */ "webhook-custom-property-deleted": { @@ -32493,18 +34429,18 @@ export interface components { }; enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; - organization: components["schemas"]["organization-simple-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** custom property updated event */ "webhook-custom-property-updated": { /** @enum {string} */ action: "updated"; - definition: components["schemas"]["org-custom-property"]; + definition: components["schemas"]["custom-property"]; enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; - organization: components["schemas"]["organization-simple-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** Custom property values updated event */ "webhook-custom-property-values-updated": { @@ -32514,7 +34450,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; repository: components["schemas"]["repository-webhooks"]; organization: components["schemas"]["organization-simple-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; /** @description The new custom property values for the repository. */ new_property_values: components["schemas"]["custom-property-value"][]; /** @description The old custom property values for the repository. */ @@ -32533,7 +34469,7 @@ export interface components { */ ref_type: "tag" | "branch"; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Dependabot alert auto-dismissed event */ "webhook-dependabot-alert-auto-dismissed": { @@ -32544,7 +34480,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; enterprise?: components["schemas"]["enterprise-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Dependabot alert auto-reopened event */ "webhook-dependabot-alert-auto-reopened": { @@ -32555,7 +34491,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; enterprise?: components["schemas"]["enterprise-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Dependabot alert created event */ "webhook-dependabot-alert-created": { @@ -32566,7 +34502,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; enterprise?: components["schemas"]["enterprise-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Dependabot alert dismissed event */ "webhook-dependabot-alert-dismissed": { @@ -32577,7 +34513,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; enterprise?: components["schemas"]["enterprise-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Dependabot alert fixed event */ "webhook-dependabot-alert-fixed": { @@ -32588,7 +34524,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; enterprise?: components["schemas"]["enterprise-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Dependabot alert reintroduced event */ "webhook-dependabot-alert-reintroduced": { @@ -32599,7 +34535,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; enterprise?: components["schemas"]["enterprise-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Dependabot alert reopened event */ "webhook-dependabot-alert-reopened": { @@ -32610,7 +34546,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; enterprise?: components["schemas"]["enterprise-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** deploy_key created event */ "webhook-deploy-key-created": { @@ -32621,7 +34557,7 @@ export interface components { key: components["schemas"]["webhooks_deploy_key"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** deploy_key deleted event */ "webhook-deploy-key-deleted": { @@ -32632,7 +34568,7 @@ export interface components { key: components["schemas"]["webhooks_deploy_key"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** deployment created event */ "webhook-deployment-created": { @@ -32680,6 +34616,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; environment: string; @@ -32793,6 +34730,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -32889,7 +34827,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; workflow: components["schemas"]["webhooks_workflow"]; /** Deployment Workflow Run */ workflow_run: { @@ -32929,6 +34867,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; artifacts_url?: string; cancel_url?: string; @@ -33179,6 +35118,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** Format: date-time */ updated_at: string; @@ -33206,7 +35146,7 @@ export interface components { repository?: components["schemas"]["repository-webhooks"]; organization?: components["schemas"]["organization-simple-webhooks"]; installation?: components["schemas"]["simple-installation"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; "webhook-deployment-review-approved": { /** @enum {string} */ @@ -33218,7 +35158,7 @@ export interface components { organization: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; reviewers?: components["schemas"]["webhooks_reviewers"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; since: string; workflow_job_run?: components["schemas"]["webhooks_workflow_job_run"]; workflow_job_runs?: { @@ -33269,6 +35209,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; artifacts_url?: string; cancel_url?: string; @@ -33345,6 +35286,7 @@ export interface components { subscriptions_url?: string; type?: string; url?: string; + user_view_type?: string; }; private?: boolean; pulls_url?: string; @@ -33457,6 +35399,7 @@ export interface components { subscriptions_url?: string; type?: string; url?: string; + user_view_type?: string; }; private?: boolean; pulls_url?: string; @@ -33519,6 +35462,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** Format: date-time */ updated_at: string; @@ -33538,7 +35482,7 @@ export interface components { organization: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; reviewers?: components["schemas"]["webhooks_reviewers"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; since: string; workflow_job_run?: components["schemas"]["webhooks_workflow_job_run"]; workflow_job_runs?: { @@ -33589,6 +35533,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; artifacts_url?: string; cancel_url?: string; @@ -33664,6 +35609,7 @@ export interface components { subscriptions_url?: string; type?: string; url?: string; + user_view_type?: string; }; private?: boolean; pulls_url?: string; @@ -33776,6 +35722,7 @@ export interface components { subscriptions_url?: string; type?: string; url?: string; + user_view_type?: string; }; private?: boolean; pulls_url?: string; @@ -33837,6 +35784,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** Format: date-time */ updated_at: string; @@ -33893,11 +35841,12 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @enum {string} */ type?: "User" | "Team"; }[]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; since: string; workflow_job_run: { conclusion: unknown; @@ -33947,6 +35896,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; artifacts_url?: string; cancel_url?: string; @@ -34022,6 +35972,7 @@ export interface components { subscriptions_url?: string; type?: string; url?: string; + user_view_type?: string; }; private?: boolean; pulls_url?: string; @@ -34134,6 +36085,7 @@ export interface components { subscriptions_url?: string; type?: string; url?: string; + user_view_type?: string; }; private?: boolean; pulls_url?: string; @@ -34196,6 +36148,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** Format: date-time */ updated_at: string; @@ -34291,6 +36244,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; environment: string; @@ -34404,6 +36358,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -34535,6 +36490,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** Format: uri */ deployment_url: string; @@ -34653,6 +36609,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -34746,7 +36703,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; workflow?: components["schemas"]["webhooks_workflow"]; /** Deployment Workflow Run */ workflow_run?: { @@ -34786,6 +36743,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; artifacts_url?: string; cancel_url?: string; @@ -35037,6 +36995,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** Format: date-time */ updated_at: string; @@ -35056,7 +37015,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion category changed event */ "webhook-discussion-category-changed": { @@ -35084,7 +37043,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion closed event */ "webhook-discussion-closed": { @@ -35095,7 +37054,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion_comment created event */ "webhook-discussion-comment-created": { @@ -35107,7 +37066,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion_comment deleted event */ "webhook-discussion-comment-deleted": { @@ -35119,7 +37078,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion_comment edited event */ "webhook-discussion-comment-edited": { @@ -35136,7 +37095,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion created event */ "webhook-discussion-created": { @@ -35147,7 +37106,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion deleted event */ "webhook-discussion-deleted": { @@ -35158,7 +37117,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion edited event */ "webhook-discussion-edited": { @@ -35177,7 +37136,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion labeled event */ "webhook-discussion-labeled": { @@ -35189,7 +37148,7 @@ export interface components { label: components["schemas"]["webhooks_label"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion locked event */ "webhook-discussion-locked": { @@ -35200,7 +37159,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion pinned event */ "webhook-discussion-pinned": { @@ -35211,7 +37170,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion reopened event */ "webhook-discussion-reopened": { @@ -35222,7 +37181,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion transferred event */ "webhook-discussion-transferred": { @@ -35237,7 +37196,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion unanswered event */ "webhook-discussion-unanswered": { @@ -35247,7 +37206,7 @@ export interface components { old_answer: components["schemas"]["webhooks_answer"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** discussion unlabeled event */ "webhook-discussion-unlabeled": { @@ -35259,7 +37218,7 @@ export interface components { label: components["schemas"]["webhooks_label"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion unlocked event */ "webhook-discussion-unlocked": { @@ -35270,7 +37229,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion unpinned event */ "webhook-discussion-unpinned": { @@ -35281,7 +37240,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** * fork event @@ -35342,10 +37301,6 @@ export interface components { /** Format: uri */ contributors_url: string; created_at: number | 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?: { - [key: string]: unknown; - }; /** @description The default branch of the repository. */ default_branch: string; /** @@ -35402,7 +37357,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -35478,6 +37436,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -35629,13 +37588,13 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** github_app_authorization revoked event */ "webhook-github-app-authorization-revoked": { /** @enum {string} */ action: "revoked"; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** gollum event */ "webhook-gollum": { @@ -35663,7 +37622,7 @@ export interface components { title: string; }[]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** installation created event */ "webhook-installation-created": { @@ -35675,7 +37634,7 @@ export interface components { repositories?: components["schemas"]["webhooks_repositories"]; repository?: components["schemas"]["repository-webhooks"]; requester?: components["schemas"]["webhooks_user"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** installation deleted event */ "webhook-installation-deleted": { @@ -35687,7 +37646,7 @@ export interface components { repositories?: components["schemas"]["webhooks_repositories"]; repository?: components["schemas"]["repository-webhooks"]; requester?: unknown; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** installation new_permissions_accepted event */ "webhook-installation-new-permissions-accepted": { @@ -35699,7 +37658,7 @@ export interface components { repositories?: components["schemas"]["webhooks_repositories"]; repository?: components["schemas"]["repository-webhooks"]; requester?: unknown; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** installation_repositories added event */ "webhook-installation-repositories-added": { @@ -35723,7 +37682,7 @@ export interface components { repository?: components["schemas"]["repository-webhooks"]; repository_selection: components["schemas"]["webhooks_repository_selection"]; requester: components["schemas"]["webhooks_user"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** installation_repositories removed event */ "webhook-installation-repositories-removed": { @@ -35747,7 +37706,7 @@ export interface components { repository?: components["schemas"]["repository-webhooks"]; repository_selection: components["schemas"]["webhooks_repository_selection"]; requester: components["schemas"]["webhooks_user"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** installation suspend event */ "webhook-installation-suspend": { @@ -35759,7 +37718,7 @@ export interface components { repositories?: components["schemas"]["webhooks_repositories"]; repository?: components["schemas"]["repository-webhooks"]; requester?: unknown; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; "webhook-installation-target-renamed": { account: { @@ -35799,6 +37758,7 @@ export interface components { updated_at?: string; url?: string; website_url?: unknown; + user_view_type?: string; }; /** @enum {string} */ action: "renamed"; @@ -35814,7 +37774,7 @@ export interface components { installation: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; target_type: string; }; /** installation unsuspend event */ @@ -35827,7 +37787,7 @@ export interface components { repositories?: components["schemas"]["webhooks_repositories"]; repository?: components["schemas"]["repository-webhooks"]; requester?: unknown; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issue_comment created event */ "webhook-issue-comment-created": { @@ -35905,6 +37865,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -35924,6 +37885,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; enterprise?: components["schemas"]["enterprise-webhooks"]; @@ -35973,6 +37935,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -36009,6 +37972,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -36104,6 +38068,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -36234,6 +38199,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -36341,6 +38307,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -36375,6 +38347,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -36394,6 +38367,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; } & { active_lock_reason?: string | null; @@ -36433,6 +38407,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees?: (Record | null)[]; author_association?: string; @@ -36495,6 +38470,7 @@ export interface components { gists_url?: string; gravatar_id?: string; html_url?: string; + /** Format: int64 */ id?: number; login?: string; node_id?: string; @@ -36510,7 +38486,7 @@ export interface components { }; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issue_comment deleted event */ "webhook-issue-comment-deleted": { @@ -36564,6 +38540,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -36600,6 +38577,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -36695,6 +38673,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -36823,6 +38802,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -36930,6 +38910,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -36964,6 +38950,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -36983,6 +38970,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; } & { active_lock_reason?: string | null; @@ -37022,6 +39010,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees?: (Record | null)[]; author_association?: string; @@ -37084,6 +39073,7 @@ export interface components { gists_url?: string; gravatar_id?: string; html_url?: string; + /** Format: int64 */ id?: number; login?: string; node_id?: string; @@ -37095,11 +39085,12 @@ export interface components { subscriptions_url?: string; type?: string; url?: string; + user_view_type?: string; }; }; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issue_comment edited event */ "webhook-issue-comment-edited": { @@ -37154,6 +39145,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -37190,6 +39182,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -37285,6 +39278,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -37415,6 +39409,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -37522,6 +39517,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -37556,6 +39557,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -37575,6 +39577,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; } & { active_lock_reason?: string | null; @@ -37614,6 +39617,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees?: (Record | null)[]; author_association?: string; @@ -37676,6 +39680,7 @@ export interface components { gists_url?: string; gravatar_id?: string; html_url?: string; + /** Format: int64 */ id?: number; login?: string; node_id?: string; @@ -37691,7 +39696,7 @@ export interface components { }; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues assigned event */ "webhook-issues-assigned": { @@ -37706,7 +39711,7 @@ export interface components { issue: components["schemas"]["webhooks_issue"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues closed event */ "webhook-issues-closed": { @@ -37762,6 +39767,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -37798,6 +39804,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -37893,6 +39900,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -38024,6 +40032,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -38131,6 +40140,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -38165,6 +40180,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -38184,6 +40200,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; } & { active_lock_reason?: string | null; @@ -38232,6 +40249,7 @@ export interface components { gists_url?: string; gravatar_id?: string; html_url?: string; + /** Format: int64 */ id?: number; login?: string; node_id?: string; @@ -38243,11 +40261,12 @@ export interface components { subscriptions_url?: string; type?: string; url?: string; + user_view_type?: string; }; }; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues deleted event */ "webhook-issues-deleted": { @@ -38303,6 +40322,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -38434,6 +40454,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -38563,6 +40584,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -38670,6 +40692,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -38704,6 +40732,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -38723,11 +40752,12 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues demilestoned event */ "webhook-issues-demilestoned": { @@ -38914,6 +40944,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -39042,6 +41073,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -39149,6 +41181,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -39183,6 +41221,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -39202,12 +41241,13 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; milestone?: components["schemas"]["webhooks_milestone"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues edited event */ "webhook-issues-edited": { @@ -39274,6 +41314,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -39405,6 +41446,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -39536,6 +41578,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -39643,6 +41686,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -39677,6 +41726,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -39696,12 +41746,13 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; label?: components["schemas"]["webhooks_label"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues labeled event */ "webhook-issues-labeled": { @@ -39757,6 +41808,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -39888,6 +41940,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -40018,6 +42071,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -40125,6 +42179,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -40159,6 +42219,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -40178,12 +42239,13 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; label?: components["schemas"]["webhooks_label"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues locked event */ "webhook-issues-locked": { @@ -40239,6 +42301,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -40275,6 +42338,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -40371,6 +42435,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -40501,6 +42566,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -40608,6 +42674,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -40642,6 +42714,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -40661,11 +42734,12 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues milestoned event */ "webhook-issues-milestoned": { @@ -40852,6 +42926,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -40981,6 +43056,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -41088,6 +43164,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -41122,6 +43204,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -41141,12 +43224,13 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; milestone: components["schemas"]["webhooks_milestone"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues opened event */ "webhook-issues-opened": { @@ -41201,6 +43285,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -41237,6 +43322,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -41332,6 +43418,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -41460,6 +43547,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -41567,6 +43655,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -41601,6 +43695,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -41620,6 +43715,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; } | null; /** @@ -41740,7 +43836,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -41816,6 +43915,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -41916,6 +44016,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -41952,6 +44053,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -42047,6 +44149,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -42178,6 +44281,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -42285,6 +44389,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -42319,6 +44429,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -42338,11 +44449,12 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues pinned event */ "webhook-issues-pinned": { @@ -42353,7 +44465,7 @@ export interface components { issue: components["schemas"]["webhooks_issue_2"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues reopened event */ "webhook-issues-reopened": { @@ -42540,6 +44652,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -42670,6 +44783,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -42777,6 +44891,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -42811,6 +44931,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -42830,11 +44951,12 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues transferred event */ "webhook-issues-transferred": { @@ -42889,6 +45011,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -42925,6 +45048,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -43020,6 +45144,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -43148,6 +45273,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -43255,6 +45381,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -43289,6 +45421,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -43308,6 +45441,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** @@ -43431,7 +45565,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -43507,6 +45644,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -43562,7 +45700,7 @@ export interface components { issue: components["schemas"]["webhooks_issue_2"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues unassigned event */ "webhook-issues-unassigned": { @@ -43577,7 +45715,7 @@ export interface components { issue: components["schemas"]["webhooks_issue"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues unlabeled event */ "webhook-issues-unlabeled": { @@ -43589,7 +45727,7 @@ export interface components { label?: components["schemas"]["webhooks_label"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues unlocked event */ "webhook-issues-unlocked": { @@ -43645,6 +45783,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -43681,6 +45820,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -43777,6 +45917,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -43905,6 +46046,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -44012,6 +46154,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -44046,6 +46194,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -44065,11 +46214,12 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues unpinned event */ "webhook-issues-unpinned": { @@ -44080,7 +46230,7 @@ export interface components { issue: components["schemas"]["webhooks_issue_2"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** label created event */ "webhook-label-created": { @@ -44091,7 +46241,7 @@ export interface components { label: components["schemas"]["webhooks_label"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** label deleted event */ "webhook-label-deleted": { @@ -44102,7 +46252,7 @@ export interface components { label: components["schemas"]["webhooks_label"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** label edited event */ "webhook-label-edited": { @@ -44128,7 +46278,7 @@ export interface components { label: components["schemas"]["webhooks_label"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** marketplace_purchase cancelled event */ "webhook-marketplace-purchase-cancelled": { @@ -44141,7 +46291,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; previous_marketplace_purchase?: components["schemas"]["webhooks_previous_marketplace_purchase"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** marketplace_purchase changed event */ "webhook-marketplace-purchase-changed": { @@ -44180,7 +46330,7 @@ export interface components { unit_count: number; }; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** marketplace_purchase pending_change event */ "webhook-marketplace-purchase-pending-change": { @@ -44219,7 +46369,7 @@ export interface components { unit_count: number; }; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** marketplace_purchase pending_change_cancelled event */ "webhook-marketplace-purchase-pending-change-cancelled": { @@ -44258,7 +46408,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; previous_marketplace_purchase?: components["schemas"]["webhooks_previous_marketplace_purchase"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** marketplace_purchase purchased event */ "webhook-marketplace-purchase-purchased": { @@ -44271,7 +46421,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; previous_marketplace_purchase?: components["schemas"]["webhooks_previous_marketplace_purchase"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** member added event */ "webhook-member-added": { @@ -44298,7 +46448,7 @@ export interface components { member: components["schemas"]["webhooks_user"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** member edited event */ "webhook-member-edited": { @@ -44320,7 +46470,7 @@ export interface components { member: components["schemas"]["webhooks_user"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** member removed event */ "webhook-member-removed": { @@ -44331,7 +46481,7 @@ export interface components { member: components["schemas"]["webhooks_user"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** membership added event */ "webhook-membership-added": { @@ -44383,6 +46533,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; team: components["schemas"]["webhooks_team"]; }; @@ -44436,6 +46587,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; team: components["schemas"]["webhooks_team"]; }; @@ -44446,7 +46598,7 @@ export interface components { merge_group: components["schemas"]["merge-group"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; "webhook-merge-group-destroyed": { /** @enum {string} */ @@ -44460,7 +46612,7 @@ export interface components { merge_group: components["schemas"]["merge-group"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** meta deleted event */ "webhook-meta-deleted": { @@ -44543,7 +46695,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["nullable-repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** milestone closed event */ "webhook-milestone-closed": { @@ -44554,7 +46706,7 @@ export interface components { milestone: components["schemas"]["webhooks_milestone"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** milestone created event */ "webhook-milestone-created": { @@ -44565,7 +46717,7 @@ export interface components { milestone: components["schemas"]["webhooks_milestone_3"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** milestone deleted event */ "webhook-milestone-deleted": { @@ -44576,7 +46728,7 @@ export interface components { milestone: components["schemas"]["webhooks_milestone"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** milestone edited event */ "webhook-milestone-edited": { @@ -44602,7 +46754,7 @@ export interface components { milestone: components["schemas"]["webhooks_milestone"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** milestone opened event */ "webhook-milestone-opened": { @@ -44613,7 +46765,7 @@ export interface components { milestone: components["schemas"]["webhooks_milestone_3"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** org_block blocked event */ "webhook-org-block-blocked": { @@ -44624,7 +46776,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** org_block unblocked event */ "webhook-org-block-unblocked": { @@ -44635,7 +46787,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** organization deleted event */ "webhook-organization-deleted": { @@ -44646,7 +46798,7 @@ export interface components { membership?: components["schemas"]["webhooks_membership"]; organization: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** organization member_added event */ "webhook-organization-member-added": { @@ -44657,7 +46809,7 @@ export interface components { membership: components["schemas"]["webhooks_membership"]; organization: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** organization member_invited event */ "webhook-organization-member-invited": { @@ -44712,6 +46864,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; login: string | null; node_id: string; @@ -44721,7 +46874,7 @@ export interface components { }; organization: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; user?: components["schemas"]["webhooks_user"]; }; /** organization member_removed event */ @@ -44733,7 +46886,7 @@ export interface components { membership: components["schemas"]["webhooks_membership"]; organization: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** organization renamed event */ "webhook-organization-renamed": { @@ -44749,7 +46902,7 @@ export interface components { membership?: components["schemas"]["webhooks_membership"]; organization: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Ruby Gems metadata */ "webhook-rubygems-metadata": { @@ -44823,6 +46976,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; package_type: string; package_version: { @@ -44862,6 +47016,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; body?: string | Record; body_html?: string; @@ -44999,6 +47154,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; created_at: string; draft: boolean; @@ -45034,7 +47190,7 @@ export interface components { updated_at: string | null; }; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** package updated event */ "webhook-package-updated": { @@ -45089,6 +47245,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; package_type: string; package_version: { @@ -45128,6 +47285,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; body: string; body_html: string; @@ -45199,6 +47357,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; created_at: string; draft: boolean; @@ -45235,7 +47394,7 @@ export interface components { updated_at: string; }; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** page_build event */ "webhook-page-build": { @@ -45283,6 +47442,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; status: string; updated_at: string; @@ -45294,15 +47454,16 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** personal_access_token_request approved event */ "webhook-personal-access-token-request-approved": { /** @enum {string} */ action: "approved"; personal_access_token_request: components["schemas"]["personal-access-token-request"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; organization: components["schemas"]["organization-simple-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; installation: components["schemas"]["simple-installation"]; }; /** personal_access_token_request cancelled event */ @@ -45310,8 +47471,9 @@ export interface components { /** @enum {string} */ action: "cancelled"; personal_access_token_request: components["schemas"]["personal-access-token-request"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; organization: components["schemas"]["organization-simple-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; installation: components["schemas"]["simple-installation"]; }; /** personal_access_token_request created event */ @@ -45319,9 +47481,10 @@ export interface components { /** @enum {string} */ action: "created"; personal_access_token_request: components["schemas"]["personal-access-token-request"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; organization: components["schemas"]["organization-simple-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - installation: components["schemas"]["simple-installation"]; + sender: components["schemas"]["simple-user"]; + installation?: components["schemas"]["simple-installation"]; }; /** personal_access_token_request denied event */ "webhook-personal-access-token-request-denied": { @@ -45329,7 +47492,8 @@ export interface components { action: "denied"; personal_access_token_request: components["schemas"]["personal-access-token-request"]; organization: components["schemas"]["organization-simple-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + sender: components["schemas"]["simple-user"]; installation: components["schemas"]["simple-installation"]; }; "webhook-ping": { @@ -45376,7 +47540,7 @@ export interface components { hook_id?: number; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; /** @description Random string of GitHub zen. */ zen?: string; }; @@ -45399,7 +47563,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; project_card: components["schemas"]["webhooks_project_card"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** project_card created event */ "webhook-project-card-created": { @@ -45410,7 +47574,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; project_card: components["schemas"]["webhooks_project_card"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** project_card deleted event */ "webhook-project-card-deleted": { @@ -45467,6 +47631,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The project card's ID */ id: number; @@ -45480,7 +47645,7 @@ export interface components { url: string; }; repository?: components["schemas"]["nullable-repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** project_card edited event */ "webhook-project-card-edited": { @@ -45496,7 +47661,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; project_card: components["schemas"]["webhooks_project_card"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** project_card moved event */ "webhook-project-card-moved": { @@ -45557,6 +47722,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The project card's ID */ id: number; @@ -45602,7 +47768,7 @@ export interface components { url?: string; }; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** project closed event */ "webhook-project-closed": { @@ -45613,7 +47779,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; project: components["schemas"]["webhooks_project"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** project_column created event */ "webhook-project-column-created": { @@ -45624,7 +47790,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; project_column: components["schemas"]["webhooks_project_column"]; repository?: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** project_column deleted event */ "webhook-project-column-deleted": { @@ -45635,7 +47801,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; project_column: components["schemas"]["webhooks_project_column"]; repository?: components["schemas"]["nullable-repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** project_column edited event */ "webhook-project-column-edited": { @@ -45651,7 +47817,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; project_column: components["schemas"]["webhooks_project_column"]; repository?: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** project_column moved event */ "webhook-project-column-moved": { @@ -45662,7 +47828,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; project_column: components["schemas"]["webhooks_project_column"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** project created event */ "webhook-project-created": { @@ -45673,7 +47839,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; project: components["schemas"]["webhooks_project"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** project deleted event */ "webhook-project-deleted": { @@ -45684,7 +47850,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; project: components["schemas"]["webhooks_project"]; repository?: components["schemas"]["nullable-repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** project edited event */ "webhook-project-edited": { @@ -45706,7 +47872,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; project: components["schemas"]["webhooks_project"]; repository?: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** project reopened event */ "webhook-project-reopened": { @@ -45717,7 +47883,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; project: components["schemas"]["webhooks_project"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Projects v2 Project Closed Event */ "webhook-projects-v2-project-closed": { @@ -45726,7 +47892,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; projects_v2: components["schemas"]["projects-v2"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** @description A project was created */ "webhook-projects-v2-project-created": { @@ -45735,7 +47901,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; projects_v2: components["schemas"]["projects-v2"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Projects v2 Project Deleted Event */ "webhook-projects-v2-project-deleted": { @@ -45744,7 +47910,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; projects_v2: components["schemas"]["projects-v2"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Projects v2 Project Edited Event */ "webhook-projects-v2-project-edited": { @@ -45771,7 +47937,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; projects_v2: components["schemas"]["projects-v2"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Projects v2 Item Archived Event */ "webhook-projects-v2-item-archived": { @@ -45781,7 +47947,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; projects_v2_item: components["schemas"]["projects-v2-item"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Projects v2 Item Converted Event */ "webhook-projects-v2-item-converted": { @@ -45796,7 +47962,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; projects_v2_item: components["schemas"]["projects-v2-item"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Projects v2 Item Created Event */ "webhook-projects-v2-item-created": { @@ -45805,7 +47971,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; projects_v2_item: components["schemas"]["projects-v2-item"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Projects v2 Item Deleted Event */ "webhook-projects-v2-item-deleted": { @@ -45814,18 +47980,36 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; projects_v2_item: components["schemas"]["projects-v2-item"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Projects v2 Item Edited Event */ "webhook-projects-v2-item-edited": { /** @enum {string} */ action: "edited"; + /** + * @description The changes made to the item may involve modifications in the item's fields and draft issue body. + * It includes altered values for text, number, date, single select, and iteration fields, along with the GraphQL node ID of the changed field. + */ changes?: OneOf< [ { field_value: { field_node_id?: string; field_type?: string; + field_name?: string; + project_number?: number; + from?: + | string + | number + | components["schemas"]["projects-v2-single-select-option"] + | components["schemas"]["projects-v2-iteration-setting"] + | null; + to?: + | string + | number + | components["schemas"]["projects-v2-single-select-option"] + | components["schemas"]["projects-v2-iteration-setting"] + | null; }; }, { @@ -45839,7 +48023,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; projects_v2_item: components["schemas"]["projects-v2-item"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Projects v2 Item Reordered Event */ "webhook-projects-v2-item-reordered": { @@ -45854,7 +48038,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; projects_v2_item: components["schemas"]["projects-v2-item"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Projects v2 Item Restored Event */ "webhook-projects-v2-item-restored": { @@ -45864,7 +48048,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; projects_v2_item: components["schemas"]["projects-v2-item"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Projects v2 Project Reopened Event */ "webhook-projects-v2-project-reopened": { @@ -45873,7 +48057,70 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; projects_v2: components["schemas"]["projects-v2"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; + }; + /** Projects v2 Status Update Created Event */ + "webhook-projects-v2-status-update-created": { + /** @enum {string} */ + action: "created"; + installation?: components["schemas"]["simple-installation"]; + organization: components["schemas"]["organization-simple-webhooks"]; + projects_v2_status_update: components["schemas"]["projects-v2-status-update"]; + sender: components["schemas"]["simple-user"]; + }; + /** Projects v2 Status Update Deleted Event */ + "webhook-projects-v2-status-update-deleted": { + /** @enum {string} */ + action: "deleted"; + installation?: components["schemas"]["simple-installation"]; + organization: components["schemas"]["organization-simple-webhooks"]; + projects_v2_status_update: components["schemas"]["projects-v2-status-update"]; + sender: components["schemas"]["simple-user"]; + }; + /** Projects v2 Status Update Edited Event */ + "webhook-projects-v2-status-update-edited": { + /** @enum {string} */ + action: "edited"; + changes?: { + body?: { + from?: string | null; + to?: string | null; + }; + status?: { + /** @enum {string|null} */ + from?: + | "INACTIVE" + | "ON_TRACK" + | "AT_RISK" + | "OFF_TRACK" + | "COMPLETE" + | null; + /** @enum {string|null} */ + to?: + | "INACTIVE" + | "ON_TRACK" + | "AT_RISK" + | "OFF_TRACK" + | "COMPLETE" + | null; + }; + start_date?: { + /** Format: date */ + from?: string | null; + /** Format: date */ + to?: string | null; + }; + target_date?: { + /** Format: date */ + from?: string | null; + /** Format: date */ + to?: string | null; + }; + }; + installation?: components["schemas"]["simple-installation"]; + organization: components["schemas"]["organization-simple-webhooks"]; + projects_v2_status_update: components["schemas"]["projects-v2-status-update"]; + sender: components["schemas"]["simple-user"]; }; /** public event */ "webhook-public": { @@ -45881,7 +48128,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request assigned event */ "webhook-pull-request-assigned": { @@ -45980,6 +48227,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -46016,6 +48264,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -46076,6 +48325,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -46203,7 +48453,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -46296,6 +48549,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -46359,7 +48613,7 @@ export interface components { /** Format: uri */ url: string; /** - * @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. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -46388,6 +48642,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -46407,6 +48662,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -46546,7 +48802,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -46639,6 +48898,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -46702,7 +48962,7 @@ export interface components { /** Format: uri */ url: string; /** - * @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. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -46731,6 +48991,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -46750,6 +49011,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -46817,6 +49079,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Milestone @@ -46864,6 +49127,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -46932,6 +49196,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null, { deleted?: boolean; @@ -47072,6 +49337,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -47091,10 +49357,11 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request auto_merge_disabled event */ "webhook-pull-request-auto-merge-disabled": { @@ -47192,6 +49459,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -47288,6 +49556,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -47415,7 +49684,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -47508,6 +49780,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -47571,7 +49844,7 @@ export interface components { /** Format: uri */ url: string; /** - * @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. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -47600,6 +49873,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -47619,6 +49893,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -47758,7 +50033,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -47851,6 +50129,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -47914,7 +50193,7 @@ export interface components { /** Format: uri */ url: string; /** - * @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. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -47943,6 +50222,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -47962,6 +50242,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -48029,6 +50310,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Milestone @@ -48076,6 +50358,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -48144,6 +50427,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null, { deleted?: boolean; @@ -48284,6 +50568,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -48303,11 +50588,12 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; reason: string; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request auto_merge_enabled event */ "webhook-pull-request-auto-merge-enabled": { @@ -48405,6 +50691,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -48501,6 +50788,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -48628,7 +50916,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -48721,6 +51012,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -48784,7 +51076,7 @@ export interface components { /** Format: uri */ url: string; /** - * @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. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -48813,6 +51105,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -48832,6 +51125,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -49064,6 +51358,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -49127,7 +51422,7 @@ export interface components { /** Format: uri */ url: string; /** - * @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. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -49156,6 +51451,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -49175,6 +51471,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -49242,6 +51539,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Milestone @@ -49289,6 +51587,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -49357,6 +51656,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null, { deleted?: boolean; @@ -49497,6 +51797,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -49516,11 +51817,12 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; reason?: string; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request closed event */ "webhook-pull-request-closed": { @@ -49532,7 +51834,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; pull_request: components["schemas"]["pull-request-webhook"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request converted_to_draft event */ "webhook-pull-request-converted-to-draft": { @@ -49544,7 +51846,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; pull_request: components["schemas"]["pull-request-webhook"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request demilestoned event */ "webhook-pull-request-demilestoned": { @@ -49556,7 +51858,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; pull_request: components["schemas"]["webhooks_pull_request_5"]; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** pull_request dequeued event */ "webhook-pull-request-dequeued": { @@ -49654,6 +51956,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -49750,6 +52053,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -49877,7 +52181,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -49970,6 +52277,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -50033,7 +52341,7 @@ export interface components { /** Format: uri */ url: string; /** - * @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. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -50062,6 +52370,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -50081,6 +52390,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -50220,7 +52530,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -50313,6 +52626,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -50376,7 +52690,7 @@ export interface components { /** Format: uri */ url: string; /** - * @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. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -50405,6 +52719,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -50424,6 +52739,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -50491,6 +52807,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Milestone @@ -50538,6 +52855,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -50606,6 +52924,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null, { deleted?: boolean; @@ -50746,6 +53065,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -50765,11 +53085,25 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; - reason: string; + /** @enum {string} */ + reason: + | "UNKNOWN_REMOVAL_REASON" + | "MANUAL" + | "MERGE" + | "MERGE_CONFLICT" + | "CI_FAILURE" + | "CI_TIMEOUT" + | "ALREADY_MERGED" + | "QUEUE_CLEARED" + | "ROLL_BACK" + | "BRANCH_PROTECTIONS" + | "GIT_TREE_INVALID" + | "INVALID_MERGE_COMMIT"; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request edited event */ "webhook-pull-request-edited": { @@ -50800,7 +53134,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; pull_request: components["schemas"]["pull-request-webhook"]; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** pull_request enqueued event */ "webhook-pull-request-enqueued": { @@ -50898,6 +53232,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -50994,6 +53329,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -51121,7 +53457,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -51214,6 +53553,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -51277,7 +53617,7 @@ export interface components { /** Format: uri */ url: string; /** - * @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. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -51306,6 +53646,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -51325,6 +53666,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -51464,7 +53806,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -51557,6 +53902,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -51620,7 +53966,7 @@ export interface components { /** Format: uri */ url: string; /** - * @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. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -51649,6 +53995,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -51668,6 +54015,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -51735,6 +54083,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Milestone @@ -51782,6 +54131,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -51850,6 +54200,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null, { deleted?: boolean; @@ -51990,6 +54341,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -52009,10 +54361,11 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request labeled event */ "webhook-pull-request-labeled": { @@ -52111,6 +54464,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -52207,6 +54561,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -52334,7 +54689,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -52427,6 +54785,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -52490,7 +54849,7 @@ export interface components { /** Format: uri */ url: string; /** - * @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. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -52519,6 +54878,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -52538,6 +54898,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -52677,7 +55038,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -52770,6 +55134,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -52833,7 +55198,7 @@ export interface components { /** Format: uri */ url: string; /** - * @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. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -52862,6 +55227,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -52881,6 +55247,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -52948,6 +55315,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Milestone @@ -52995,6 +55363,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -53063,6 +55432,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null, { deleted?: boolean; @@ -53203,6 +55573,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -53222,10 +55593,11 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request locked event */ "webhook-pull-request-locked": { @@ -53323,6 +55695,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -53419,6 +55792,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -53546,7 +55920,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -53639,6 +56016,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -53702,7 +56080,7 @@ export interface components { /** Format: uri */ url: string; /** - * @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. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -53731,6 +56109,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -53750,6 +56129,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -53889,7 +56269,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -53982,6 +56365,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -54045,7 +56429,7 @@ export interface components { /** Format: uri */ url: string; /** - * @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. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -54074,6 +56458,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -54093,6 +56478,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -54160,6 +56546,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Milestone @@ -54207,6 +56594,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -54275,6 +56663,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null, { deleted?: boolean; @@ -54415,6 +56804,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -54434,10 +56824,11 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request milestoned event */ "webhook-pull-request-milestoned": { @@ -54449,7 +56840,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; pull_request: components["schemas"]["webhooks_pull_request_5"]; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** pull_request opened event */ "webhook-pull-request-opened": { @@ -54461,7 +56852,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; pull_request: components["schemas"]["pull-request-webhook"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request ready_for_review event */ "webhook-pull-request-ready-for-review": { @@ -54473,7 +56864,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; pull_request: components["schemas"]["pull-request-webhook"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request reopened event */ "webhook-pull-request-reopened": { @@ -54485,7 +56876,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; pull_request: components["schemas"]["pull-request-webhook"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request_review_comment created event */ "webhook-pull-request-review-comment-created": { @@ -54623,6 +57014,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -54642,6 +57034,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; enterprise?: components["schemas"]["enterprise-webhooks"]; @@ -54733,6 +57126,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -54829,6 +57223,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -54956,7 +57351,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -55049,6 +57447,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -55112,7 +57511,7 @@ export interface components { /** Format: uri */ url: string; /** - * @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. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -55141,6 +57540,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -55160,6 +57560,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -55292,7 +57693,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -55385,6 +57789,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -55448,7 +57853,7 @@ export interface components { /** Format: uri */ url: string; /** - * @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. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -55477,6 +57882,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -55496,6 +57902,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -55567,6 +57974,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -55633,6 +58041,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null, { deleted?: boolean; @@ -55767,6 +58176,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -55786,10 +58196,11 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request_review_comment deleted event */ "webhook-pull-request-review-comment-deleted": { @@ -55885,6 +58296,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -55981,6 +58393,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -56108,7 +58521,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -56201,6 +58617,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -56264,7 +58681,7 @@ export interface components { /** Format: uri */ url: string; /** - * @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. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -56293,6 +58710,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -56312,6 +58730,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -56444,7 +58863,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -56537,6 +58959,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -56600,7 +59023,7 @@ export interface components { /** Format: uri */ url: string; /** - * @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. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -56629,6 +59052,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -56648,6 +59072,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -56719,6 +59144,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -56785,6 +59211,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null, { deleted?: boolean; @@ -56919,6 +59346,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -56938,10 +59366,11 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request_review_comment edited event */ "webhook-pull-request-review-comment-edited": { @@ -57038,6 +59467,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -57074,6 +59504,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -57134,6 +59565,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -57261,7 +59693,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -57354,6 +59789,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -57417,7 +59853,7 @@ export interface components { /** Format: uri */ url: string; /** - * @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. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -57446,6 +59882,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -57465,6 +59902,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -57597,7 +60035,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -57690,6 +60131,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -57753,7 +60195,7 @@ export interface components { /** Format: uri */ url: string; /** - * @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. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -57782,6 +60224,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -57801,6 +60244,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -57872,6 +60316,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -57938,6 +60383,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null, { deleted?: boolean; @@ -58072,6 +60518,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -58089,12 +60536,13 @@ export interface components { subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; + user_view_type?: string; /** Format: uri */ url?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request_review dismissed event */ "webhook-pull-request-review-dismissed": { @@ -58190,6 +60638,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -58286,6 +60735,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -58413,7 +60863,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -58506,6 +60959,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -58569,7 +61023,7 @@ export interface components { /** Format: uri */ url: string; /** - * @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. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -58598,6 +61052,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -58617,6 +61072,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -58749,7 +61205,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -58842,6 +61301,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -58905,7 +61365,7 @@ export interface components { /** Format: uri */ url: string; /** - * @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. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -58934,6 +61394,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -58953,6 +61414,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -59024,6 +61486,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -59090,6 +61553,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null, { deleted?: boolean; @@ -59224,6 +61688,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -59243,6 +61708,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; @@ -59306,6 +61772,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -59325,9 +61792,10 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request_review edited event */ "webhook-pull-request-review-edited": { @@ -59429,6 +61897,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -59525,6 +61994,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -59647,7 +62117,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -59723,6 +62196,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -59788,6 +62262,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -59807,6 +62282,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -59934,7 +62410,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -60010,6 +62489,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -60075,6 +62555,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -60094,6 +62575,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -60165,6 +62647,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -60231,6 +62714,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null, { deleted?: boolean; @@ -60365,6 +62849,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -60384,11 +62869,12 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; review: components["schemas"]["webhooks_review"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request review_request_removed event */ "webhook-pull-request-review-request-removed": OneOf< @@ -60489,6 +62975,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -60525,6 +63012,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -60585,6 +63073,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -60712,7 +63201,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -60805,6 +63297,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -60861,7 +63354,7 @@ export interface components { /** Format: uri */ url: string; /** - * @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. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -60890,6 +63383,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -60909,6 +63403,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -61048,7 +63543,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -61141,6 +63639,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -61204,7 +63703,7 @@ export interface components { /** Format: uri */ url: string; /** - * @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. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -61233,6 +63732,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -61252,6 +63752,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -61319,6 +63820,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Milestone @@ -61366,6 +63868,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -61434,6 +63937,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null, { deleted?: boolean; @@ -61574,6 +64078,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -61593,6 +64098,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; @@ -61632,8 +64138,9 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }, { /** @enum {string} */ @@ -61731,6 +64238,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -61767,6 +64275,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -61827,6 +64336,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -61954,7 +64464,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -62047,6 +64560,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -62110,7 +64624,7 @@ export interface components { /** Format: uri */ url: string; /** - * @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. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -62139,6 +64653,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -62158,6 +64673,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -62297,7 +64813,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -62390,6 +64909,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -62453,7 +64973,7 @@ export interface components { /** Format: uri */ url: string; /** - * @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. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -62482,6 +65002,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -62501,6 +65022,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -62568,6 +65090,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Milestone @@ -62615,6 +65138,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -62683,6 +65207,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null, { deleted?: boolean; @@ -62823,6 +65348,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -62842,6 +65368,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; @@ -62900,7 +65427,7 @@ export interface components { */ url: string; }; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }, ] >; @@ -63003,6 +65530,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -63039,6 +65567,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -63099,6 +65628,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -63226,7 +65756,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -63319,6 +65852,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -63382,7 +65916,7 @@ export interface components { /** Format: uri */ url: string; /** - * @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. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -63411,6 +65945,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -63430,6 +65965,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -63569,7 +66105,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -63662,6 +66201,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -63725,7 +66265,7 @@ export interface components { /** Format: uri */ url: string; /** - * @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. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -63754,6 +66294,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -63773,6 +66314,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -63840,6 +66382,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Milestone @@ -63887,6 +66430,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -63955,6 +66499,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null, { deleted?: boolean; @@ -64095,6 +66640,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -64114,6 +66660,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; @@ -64153,8 +66700,9 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }, { /** @enum {string} */ @@ -64252,6 +66800,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -64288,6 +66837,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -64348,6 +66898,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -64475,7 +67026,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -64568,6 +67122,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -64631,7 +67186,7 @@ export interface components { /** Format: uri */ url: string; /** - * @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. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -64660,6 +67215,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -64679,6 +67235,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -64818,7 +67375,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -64911,6 +67471,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -64974,7 +67535,7 @@ export interface components { /** Format: uri */ url: string; /** - * @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. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -65003,6 +67564,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -65022,6 +67584,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -65089,6 +67652,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Milestone @@ -65136,6 +67700,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -65204,6 +67769,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null, { deleted?: boolean; @@ -65344,6 +67910,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -65363,6 +67930,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; @@ -65421,7 +67989,7 @@ export interface components { */ url?: string; }; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }, ] >; @@ -65519,6 +68087,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -65615,6 +68184,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -65742,7 +68312,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -65835,6 +68408,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -65898,7 +68472,7 @@ export interface components { /** Format: uri */ url: string; /** - * @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. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -65927,6 +68501,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -65946,6 +68521,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -66078,7 +68654,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -66171,6 +68750,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -66234,7 +68814,7 @@ export interface components { /** Format: uri */ url: string; /** - * @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. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -66263,6 +68843,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -66282,6 +68863,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -66353,6 +68935,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -66419,6 +69002,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null, { deleted?: boolean; @@ -66553,6 +69137,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -66572,11 +69157,12 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; review: components["schemas"]["webhooks_review"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request_review_thread resolved event */ "webhook-pull-request-review-thread-resolved": { @@ -66672,6 +69258,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -66768,6 +69355,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -66895,7 +69483,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -66971,6 +69562,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -67038,6 +69630,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -67057,6 +69650,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -67189,7 +69783,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -67265,6 +69862,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -67332,6 +69930,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -67351,6 +69950,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -67422,6 +70022,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -67488,6 +70089,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null, { deleted?: boolean; @@ -67622,6 +70224,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -67641,10 +70244,11 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; thread: { comments: { _links: { @@ -67774,6 +70378,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -67793,6 +70398,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }[]; node_id: string; @@ -67892,6 +70498,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -67988,6 +70595,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -68115,7 +70723,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -68191,6 +70802,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -68258,6 +70870,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -68277,6 +70890,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -68409,7 +71023,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -68485,6 +71102,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -68552,6 +71170,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -68571,6 +71190,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -68642,6 +71262,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -68708,6 +71329,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null, { deleted?: boolean; @@ -68842,6 +71464,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -68861,10 +71484,11 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; thread: { comments: { _links: { @@ -68994,6 +71618,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -69013,6 +71638,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }[]; node_id: string; @@ -69116,6 +71742,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -69212,6 +71839,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -69339,7 +71967,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -69432,6 +72063,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -69495,7 +72127,7 @@ export interface components { /** Format: uri */ url: string; /** - * @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. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -69524,6 +72156,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -69543,6 +72176,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -69682,7 +72316,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -69768,6 +72405,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -69831,7 +72469,7 @@ export interface components { /** Format: uri */ url: string; /** - * @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. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -69860,6 +72498,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -69879,6 +72518,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -69946,6 +72586,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Milestone @@ -69993,6 +72634,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -70061,6 +72703,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null, { deleted?: boolean; @@ -70201,6 +72844,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -70220,10 +72864,11 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request unassigned event */ "webhook-pull-request-unassigned": { @@ -70322,6 +72967,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -70418,6 +73064,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -70545,7 +73192,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -70638,6 +73288,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -70701,7 +73352,7 @@ export interface components { /** Format: uri */ url: string; /** - * @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. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -70730,6 +73381,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -70749,6 +73401,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -70888,7 +73541,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -70981,6 +73637,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -71044,7 +73701,7 @@ export interface components { /** Format: uri */ url: string; /** - * @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. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -71073,6 +73730,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -71092,6 +73750,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -71159,6 +73818,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Milestone @@ -71206,6 +73866,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -71274,6 +73935,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null, { deleted?: boolean; @@ -71414,6 +74076,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -71433,10 +74096,11 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** pull_request unlabeled event */ "webhook-pull-request-unlabeled": { @@ -71535,6 +74199,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -71631,6 +74296,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -71758,7 +74424,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -71851,6 +74520,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -71914,7 +74584,7 @@ export interface components { /** Format: uri */ url: string; /** - * @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. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -71943,6 +74613,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -71962,6 +74633,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -72101,7 +74773,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -72187,6 +74862,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -72250,7 +74926,7 @@ export interface components { /** Format: uri */ url: string; /** - * @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. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -72279,6 +74955,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -72298,6 +74975,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -72365,6 +75043,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Milestone @@ -72412,6 +75091,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -72480,6 +75160,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null, { deleted?: boolean; @@ -72620,6 +75301,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -72639,10 +75321,11 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request unlocked event */ "webhook-pull-request-unlocked": { @@ -72740,6 +75423,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -72836,6 +75520,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -72963,7 +75648,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -73056,6 +75744,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -73119,7 +75808,7 @@ export interface components { /** Format: uri */ url: string; /** - * @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. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -73148,6 +75837,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -73167,6 +75857,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -73306,7 +75997,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -73399,6 +76093,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -73462,7 +76157,7 @@ export interface components { /** Format: uri */ url: string; /** - * @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. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -73491,6 +76186,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -73510,6 +76206,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -73577,6 +76274,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Milestone @@ -73624,6 +76322,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -73692,6 +76391,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null, { deleted?: boolean; @@ -73832,6 +76532,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -73851,10 +76552,11 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** push event */ "webhook-push": { @@ -74112,7 +76814,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -74188,6 +76893,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -74237,7 +76943,7 @@ export interface components { /** @description Whether to require contributors to sign off on web-based commits */ web_commit_signoff_required?: boolean; }; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; "webhook-registry-package-published": { /** @enum {string} */ @@ -74272,6 +76978,7 @@ export interface components { subscriptions_url: string; type: string; url: string; + user_view_type?: string; }; package_type: string; package_version: { @@ -74294,6 +77001,7 @@ export interface components { subscriptions_url: string; type: string; url: string; + user_view_type?: string; }; body?: string | Record; body_html?: string; @@ -74412,6 +77120,7 @@ export interface components { subscriptions_url?: string; type?: string; url?: string; + user_view_type?: string; }; created_at?: string; draft?: boolean; @@ -74442,7 +77151,7 @@ export interface components { updated_at: string | null; }; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; "webhook-registry-package-updated": { /** @enum {string} */ @@ -74477,6 +77186,7 @@ export interface components { subscriptions_url: string; type: string; url: string; + user_view_type?: string; }; package_type: string; package_version: { @@ -74499,6 +77209,7 @@ export interface components { subscriptions_url: string; type: string; url: string; + user_view_type?: string; }; body: string; body_html: string; @@ -74551,6 +77262,7 @@ export interface components { subscriptions_url: string; type: string; url: string; + user_view_type?: string; }; created_at: string; draft: boolean; @@ -74575,7 +77287,7 @@ export interface components { updated_at: string; }; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** release created event */ "webhook-release-created": { @@ -74586,7 +77298,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; release: components["schemas"]["webhooks_release"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** release deleted event */ "webhook-release-deleted": { @@ -74597,7 +77309,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; release: components["schemas"]["webhooks_release"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** release edited event */ "webhook-release-edited": { @@ -74622,7 +77334,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; release: components["schemas"]["webhooks_release"]; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** release prereleased event */ "webhook-release-prereleased": { @@ -74734,6 +77446,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; body: string | null; /** Format: date-time */ @@ -74782,7 +77495,7 @@ export interface components { zipball_url: string | null; }; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** release published event */ "webhook-release-published": { @@ -74793,7 +77506,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; release: components["schemas"]["webhooks_release_1"]; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** release released event */ "webhook-release-released": { @@ -74804,7 +77517,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; release: components["schemas"]["webhooks_release"]; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** release unpublished event */ "webhook-release-unpublished": { @@ -74815,7 +77528,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; release: components["schemas"]["webhooks_release_1"]; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** Repository advisory published event */ "webhook-repository-advisory-published": { @@ -74826,7 +77539,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; repository_advisory: components["schemas"]["repository-advisory"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** Repository advisory reported event */ "webhook-repository-advisory-reported": { @@ -74837,7 +77550,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; repository_advisory: components["schemas"]["repository-advisory"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** repository archived event */ "webhook-repository-archived": { @@ -74847,7 +77560,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** repository created event */ "webhook-repository-created": { @@ -74857,7 +77570,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** repository deleted event */ "webhook-repository-deleted": { @@ -74867,7 +77580,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** repository_dispatch event */ "webhook-repository-dispatch-sample": { @@ -74882,7 +77595,7 @@ export interface components { installation: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** repository edited event */ "webhook-repository-edited": { @@ -74906,7 +77619,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** repository_import event */ "webhook-repository-import": { @@ -74914,7 +77627,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; /** @enum {string} */ status: "success" | "cancelled" | "failure"; }; @@ -74926,7 +77639,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** repository publicized event */ "webhook-repository-publicized": { @@ -74936,7 +77649,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** repository renamed event */ "webhook-repository-renamed": { @@ -74953,7 +77666,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** repository ruleset created event */ "webhook-repository-ruleset-created": { @@ -74964,7 +77677,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; repository_ruleset: components["schemas"]["repository-ruleset"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** repository ruleset deleted event */ "webhook-repository-ruleset-deleted": { @@ -74975,7 +77688,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; repository_ruleset: components["schemas"]["repository-ruleset"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** repository ruleset edited event */ "webhook-repository-ruleset-edited": { @@ -75033,7 +77746,7 @@ export interface components { }[]; }; }; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** repository transferred event */ "webhook-repository-transferred": { @@ -75084,6 +77797,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -75103,6 +77817,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; }; @@ -75111,7 +77826,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** repository unarchived event */ "webhook-repository-unarchived": { @@ -75121,7 +77836,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** repository_vulnerability_alert create event */ "webhook-repository-vulnerability-alert-create": { @@ -75132,7 +77847,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** repository_vulnerability_alert dismiss event */ "webhook-repository-vulnerability-alert-dismiss": { @@ -75185,6 +77900,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; external_identifier: string; /** Format: uri */ @@ -75205,7 +77921,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** repository_vulnerability_alert reopen event */ "webhook-repository-vulnerability-alert-reopen": { @@ -75216,7 +77932,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** repository_vulnerability_alert resolve event */ "webhook-repository-vulnerability-alert-resolve": { @@ -75288,7 +78004,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** secret_scanning_alert created event */ "webhook-secret-scanning-alert-created": { @@ -75299,7 +78015,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** Secret Scanning Alert Location Created Event */ "webhook-secret-scanning-alert-location-created": { @@ -75310,13 +78026,24 @@ export interface components { location: components["schemas"]["secret-scanning-location"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Secret Scanning Alert Location Created Event */ "webhook-secret-scanning-alert-location-created-form-encoded": { /** @description A URL-encoded string of the secret_scanning_alert_location.created JSON payload. The decoded payload is a JSON object. */ payload: string; }; + /** secret_scanning_alert publicly leaked event */ + "webhook-secret-scanning-alert-publicly-leaked": { + /** @enum {string} */ + action: "publicly_leaked"; + alert: components["schemas"]["secret-scanning-alert-webhook"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender?: components["schemas"]["simple-user"]; + }; /** secret_scanning_alert reopened event */ "webhook-secret-scanning-alert-reopened": { /** @enum {string} */ @@ -75326,7 +78053,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** secret_scanning_alert resolved event */ "webhook-secret-scanning-alert-resolved": { @@ -75337,29 +78064,61 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; - /** secret_scanning_alert revoked event */ - "webhook-secret-scanning-alert-revoked": { + /** secret_scanning_alert validated event */ + "webhook-secret-scanning-alert-validated": { /** @enum {string} */ - action: "revoked"; + action: "validated"; alert: components["schemas"]["secret-scanning-alert-webhook"]; enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; - /** secret_scanning_alert validated event */ - "webhook-secret-scanning-alert-validated": { + /** secret_scanning_scan completed event */ + "webhook-secret-scanning-scan-completed": { /** @enum {string} */ - action: "validated"; - alert: components["schemas"]["secret-scanning-alert-webhook"]; + action: "completed"; + /** + * @description What type of scan was completed + * @enum {string} + */ + type: "backfill" | "custom-pattern-backfill" | "pattern-version-backfill"; + /** + * @description What type of content was scanned + * @enum {string} + */ + source: "git" | "issues" | "pull-requests" | "discussions" | "wiki"; + /** + * Format: date-time + * @description The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + started_at: string; + /** + * Format: date-time + * @description The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + completed_at: string; + /** @description List of patterns that were updated. This will be empty for normal backfill scans or custom pattern updates */ + secret_types?: string[] | null; + /** @description If the scan was triggered by a custom pattern update, this will be the name of the pattern that was updated */ + custom_pattern_name?: string | null; + /** + * @description If the scan was triggered by a custom pattern update, this will be the scope of the pattern that was updated + * @enum {string|null} + */ + custom_pattern_scope?: + | "repository" + | "organization" + | "enterprise" + | null; + repository?: components["schemas"]["repository-webhooks"]; enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; - repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** security_advisory published event */ "webhook-security-advisory-published": { @@ -75370,7 +78129,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; security_advisory: components["schemas"]["webhooks_security_advisory"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** security_advisory updated event */ "webhook-security-advisory-updated": { @@ -75381,7 +78140,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; security_advisory: components["schemas"]["webhooks_security_advisory"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** security_advisory withdrawn event */ "webhook-security-advisory-withdrawn": { @@ -75397,6 +78156,7 @@ export interface components { score: number; vector_string: string | null; }; + cvss_severities?: components["schemas"]["cvss-severities"]; cwes: { cwe_id: string; name: string; @@ -75428,7 +78188,7 @@ export interface components { }[]; withdrawn_at: string; }; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** security_and_analysis event */ "webhook-security-and-analysis": { @@ -75441,7 +78201,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["full-repository"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** sponsorship cancelled event */ "webhook-sponsorship-cancelled": { @@ -75451,7 +78211,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; sponsorship: components["schemas"]["webhooks_sponsorship"]; }; /** sponsorship created event */ @@ -75462,7 +78222,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; sponsorship: components["schemas"]["webhooks_sponsorship"]; }; /** sponsorship edited event */ @@ -75479,7 +78239,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; sponsorship: components["schemas"]["webhooks_sponsorship"]; }; /** sponsorship pending_cancellation event */ @@ -75491,7 +78251,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; sponsorship: components["schemas"]["webhooks_sponsorship"]; }; /** sponsorship pending_tier_change event */ @@ -75504,7 +78264,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; sponsorship: components["schemas"]["webhooks_sponsorship"]; }; /** sponsorship tier_changed event */ @@ -75516,7 +78276,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; sponsorship: components["schemas"]["webhooks_sponsorship"]; }; /** star created event */ @@ -75527,7 +78287,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; /** @description The time the star was created. This is a timestamp in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. Will be `null` for the `deleted` action. */ starred_at: string | null; }; @@ -75539,7 +78299,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; /** @description The time the star was created. This is a timestamp in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. Will be `null` for the `deleted` action. */ starred_at: unknown; }; @@ -75654,6 +78414,7 @@ export interface components { | "ocsp_pending"; signature: string | null; verified: boolean; + verified_at?: string | null; }; }; /** User */ @@ -75718,7 +78479,7 @@ export interface components { name: string; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; /** @description The Commit SHA. */ sha: string; /** @@ -75730,13 +78491,77 @@ export interface components { target_url: string | null; updated_at: string; }; + /** parent issue added event */ + "webhook-sub-issues-parent-issue-added": { + /** @enum {string} */ + action: "parent_issue_added"; + /** @description The ID of the parent issue. */ + parent_issue_id: number; + parent_issue: components["schemas"]["issue"]; + parent_issue_repo: components["schemas"]["repository"]; + /** @description The ID of the sub-issue. */ + sub_issue_id: number; + sub_issue: components["schemas"]["issue"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository?: components["schemas"]["repository-webhooks"]; + sender?: components["schemas"]["simple-user"]; + }; + /** parent issue removed event */ + "webhook-sub-issues-parent-issue-removed": { + /** @enum {string} */ + action: "parent_issue_removed"; + /** @description The ID of the parent issue. */ + parent_issue_id: number; + parent_issue: components["schemas"]["issue"]; + parent_issue_repo: components["schemas"]["repository"]; + /** @description The ID of the sub-issue. */ + sub_issue_id: number; + sub_issue: components["schemas"]["issue"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository?: components["schemas"]["repository-webhooks"]; + sender?: components["schemas"]["simple-user"]; + }; + /** sub-issue added event */ + "webhook-sub-issues-sub-issue-added": { + /** @enum {string} */ + action: "sub_issue_added"; + /** @description The ID of the sub-issue. */ + sub_issue_id: number; + sub_issue: components["schemas"]["issue"]; + sub_issue_repo: components["schemas"]["repository"]; + /** @description The ID of the parent issue. */ + parent_issue_id: number; + parent_issue: components["schemas"]["issue"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository?: components["schemas"]["repository-webhooks"]; + sender?: components["schemas"]["simple-user"]; + }; + /** sub-issue removed event */ + "webhook-sub-issues-sub-issue-removed": { + /** @enum {string} */ + action: "sub_issue_removed"; + /** @description The ID of the sub-issue. */ + sub_issue_id: number; + sub_issue: components["schemas"]["issue"]; + sub_issue_repo: components["schemas"]["repository"]; + /** @description The ID of the parent issue. */ + parent_issue_id: number; + parent_issue: components["schemas"]["issue"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository?: components["schemas"]["repository-webhooks"]; + sender?: components["schemas"]["simple-user"]; + }; /** team_add event */ "webhook-team-add": { enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; team: components["schemas"]["webhooks_team_1"]; }; /** team added_to_repository event */ @@ -75862,256 +78687,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ - id: number; - is_template?: boolean; - /** Format: uri-template */ - issue_comment_url: string; - /** Format: uri-template */ - issue_events_url: string; - /** Format: uri-template */ - issues_url: string; - /** Format: uri-template */ - keys_url: string; - /** Format: uri-template */ - labels_url: string; - language: string | null; - /** Format: uri */ - languages_url: string; - /** License */ - license: { - key: string; - name: string; - node_id: string; - spdx_id: string; - /** Format: uri */ - url: string | null; - } | null; - master_branch?: string; - /** Format: uri */ - merges_url: string; - /** Format: uri-template */ - milestones_url: string; - /** Format: uri */ - mirror_url: string | null; - /** @description The name of the repository. */ - name: string; - node_id: string; - /** Format: uri-template */ - notifications_url: string; - open_issues: number; - open_issues_count: number; - organization?: string; - /** User */ - owner: { - /** Format: uri */ - avatar_url?: string; - deleted?: boolean; - email?: string | null; - /** Format: uri-template */ - events_url?: string; - /** Format: uri */ - followers_url?: string; - /** Format: uri-template */ - following_url?: string; - /** Format: uri-template */ - gists_url?: string; - gravatar_id?: string; - /** Format: uri */ - html_url?: string; - id: number; - login: string; - name?: string; - node_id?: string; - /** Format: uri */ - organizations_url?: string; - /** Format: uri */ - received_events_url?: string; - /** Format: uri */ - repos_url?: string; - site_admin?: boolean; - /** Format: uri-template */ - starred_url?: string; - /** Format: uri */ - subscriptions_url?: string; - /** @enum {string} */ - type?: "Bot" | "User" | "Organization"; - /** Format: uri */ - url?: string; - } | null; - permissions?: { - admin: boolean; - maintain?: boolean; - pull: boolean; - push: boolean; - triage?: boolean; - }; - /** @description Whether the repository is private or public. */ - private: boolean; - public?: boolean; - /** Format: uri-template */ - pulls_url: string; - pushed_at: number | string | null; - /** Format: uri-template */ - releases_url: string; - role_name?: string | null; - size: number; - ssh_url: string; - stargazers?: number; - stargazers_count: number; - /** Format: uri */ - stargazers_url: string; - /** Format: uri-template */ - statuses_url: string; - /** Format: uri */ - subscribers_url: string; - /** Format: uri */ - subscription_url: string; - /** Format: uri */ - svn_url: string; - /** Format: uri */ - tags_url: string; - /** Format: uri */ - teams_url: string; - topics: string[]; - /** Format: uri-template */ - trees_url: string; - /** Format: date-time */ - updated_at: string; - /** Format: uri */ - url: string; - /** @enum {string} */ - visibility: "public" | "private" | "internal"; - watchers: number; - watchers_count: number; - }; - sender?: components["schemas"]["simple-user-webhooks"]; - team: components["schemas"]["webhooks_team_1"]; - }; - /** team created event */ - "webhook-team-created": { - /** @enum {string} */ - action: "created"; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization: components["schemas"]["organization-simple-webhooks"]; - /** - * Repository - * @description A git repository - */ - repository?: { - /** - * @description Whether to allow auto-merge for pull requests. - * @default false - */ - allow_auto_merge?: boolean; - /** @description Whether to allow private forks */ - allow_forking?: boolean; - /** - * @description Whether to allow merge commits for pull requests. - * @default true - */ - allow_merge_commit?: boolean; /** - * @description Whether to allow rebase merges for pull requests. - * @default true - */ - allow_rebase_merge?: boolean; - /** - * @description Whether to allow squash merges for pull requests. - * @default true - */ - allow_squash_merge?: boolean; - allow_update_branch?: boolean; - /** Format: uri-template */ - archive_url: string; - /** - * @description Whether the repository is archived. - * @default false - */ - archived: boolean; - /** Format: uri-template */ - assignees_url: string; - /** Format: uri-template */ - blobs_url: string; - /** Format: uri-template */ - branches_url: string; - /** Format: uri */ - clone_url: string; - /** Format: uri-template */ - collaborators_url: string; - /** Format: uri-template */ - comments_url: string; - /** Format: uri-template */ - commits_url: string; - /** Format: uri-template */ - compare_url: string; - /** Format: uri-template */ - contents_url: string; - /** Format: uri */ - contributors_url: string; - created_at: number | 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?: { - [key: string]: unknown; - }; - /** @description The default branch of the repository. */ - default_branch: string; - /** - * @description Whether to delete head branches when pull requests are merged - * @default false - */ - delete_branch_on_merge?: boolean; - /** Format: uri */ - deployments_url: string; - description: string | null; - /** @description Returns whether or not this repository is disabled. */ - disabled?: boolean; - /** Format: uri */ - downloads_url: string; - /** Format: uri */ - events_url: string; - fork: boolean; - forks: number; - forks_count: number; - /** Format: uri */ - forks_url: string; - full_name: string; - /** Format: uri-template */ - git_commits_url: string; - /** Format: uri-template */ - git_refs_url: string; - /** Format: uri-template */ - git_tags_url: string; - /** Format: uri */ - git_url: string; - /** - * @description Whether downloads are enabled. - * @default true - */ - has_downloads: boolean; - /** - * @description Whether issues are enabled. - * @default true - */ - has_issues: boolean; - has_pages: boolean; - /** - * @description Whether projects are enabled. - * @default true - */ - has_projects: boolean; - /** - * @description Whether the wiki is enabled. - * @default true + * Format: int64 + * @description Unique identifier of the repository */ - has_wiki: boolean; - homepage: string | null; - /** Format: uri */ - hooks_url: string; - /** Format: uri */ - html_url: string; - /** @description Unique identifier of the repository */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -76187,6 +78766,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -76234,7 +78814,260 @@ export interface components { watchers: number; watchers_count: number; }; - sender: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; + team: components["schemas"]["webhooks_team_1"]; + }; + /** team created event */ + "webhook-team-created": { + /** @enum {string} */ + action: "created"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization: components["schemas"]["organization-simple-webhooks"]; + /** + * Repository + * @description A git repository + */ + repository?: { + /** + * @description Whether to allow auto-merge for pull requests. + * @default false + */ + allow_auto_merge?: boolean; + /** @description Whether to allow private forks */ + allow_forking?: boolean; + /** + * @description Whether to allow merge commits for pull requests. + * @default true + */ + allow_merge_commit?: boolean; + /** + * @description Whether to allow rebase merges for pull requests. + * @default true + */ + allow_rebase_merge?: boolean; + /** + * @description Whether to allow squash merges for pull requests. + * @default true + */ + allow_squash_merge?: boolean; + allow_update_branch?: boolean; + /** Format: uri-template */ + archive_url: string; + /** + * @description Whether the repository is archived. + * @default false + */ + archived: boolean; + /** Format: uri-template */ + assignees_url: string; + /** Format: uri-template */ + blobs_url: string; + /** Format: uri-template */ + branches_url: string; + /** Format: uri */ + clone_url: string; + /** Format: uri-template */ + collaborators_url: string; + /** Format: uri-template */ + comments_url: string; + /** Format: uri-template */ + commits_url: string; + /** Format: uri-template */ + compare_url: string; + /** Format: uri-template */ + contents_url: string; + /** Format: uri */ + contributors_url: string; + created_at: number | 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?: { + [key: string]: unknown; + }; + /** @description The default branch of the repository. */ + default_branch: string; + /** + * @description Whether to delete head branches when pull requests are merged + * @default false + */ + delete_branch_on_merge?: boolean; + /** Format: uri */ + deployments_url: string; + description: string | null; + /** @description Returns whether or not this repository is disabled. */ + disabled?: boolean; + /** Format: uri */ + downloads_url: string; + /** Format: uri */ + events_url: string; + fork: boolean; + forks: number; + forks_count: number; + /** Format: uri */ + forks_url: string; + full_name: string; + /** Format: uri-template */ + git_commits_url: string; + /** Format: uri-template */ + git_refs_url: string; + /** Format: uri-template */ + git_tags_url: string; + /** Format: uri */ + git_url: string; + /** + * @description Whether downloads are enabled. + * @default true + */ + has_downloads: boolean; + /** + * @description Whether issues are enabled. + * @default true + */ + has_issues: boolean; + has_pages: boolean; + /** + * @description Whether projects are enabled. + * @default true + */ + has_projects: boolean; + /** + * @description Whether the wiki is enabled. + * @default true + */ + has_wiki: boolean; + homepage: string | null; + /** Format: uri */ + hooks_url: string; + /** Format: uri */ + html_url: string; + /** + * Format: int64 + * @description Unique identifier of the repository + */ + id: number; + is_template?: boolean; + /** Format: uri-template */ + issue_comment_url: string; + /** Format: uri-template */ + issue_events_url: string; + /** Format: uri-template */ + issues_url: string; + /** Format: uri-template */ + keys_url: string; + /** Format: uri-template */ + labels_url: string; + language: string | null; + /** Format: uri */ + languages_url: string; + /** License */ + license: { + key: string; + name: string; + node_id: string; + spdx_id: string; + /** Format: uri */ + url: string | null; + } | null; + master_branch?: string; + /** Format: uri */ + merges_url: string; + /** Format: uri-template */ + milestones_url: string; + /** Format: uri */ + mirror_url: string | null; + /** @description The name of the repository. */ + name: string; + node_id: string; + /** Format: uri-template */ + notifications_url: string; + open_issues: number; + open_issues_count: number; + organization?: string; + /** User */ + owner: { + /** Format: uri */ + avatar_url?: string; + deleted?: boolean; + email?: string | null; + /** Format: uri-template */ + events_url?: string; + /** Format: uri */ + followers_url?: string; + /** Format: uri-template */ + following_url?: string; + /** Format: uri-template */ + gists_url?: string; + gravatar_id?: string; + /** Format: uri */ + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; + /** Format: uri */ + organizations_url?: string; + /** Format: uri */ + received_events_url?: string; + /** Format: uri */ + repos_url?: string; + site_admin?: boolean; + /** Format: uri-template */ + starred_url?: string; + /** Format: uri */ + subscriptions_url?: string; + /** @enum {string} */ + type?: "Bot" | "User" | "Organization"; + /** Format: uri */ + url?: string; + user_view_type?: string; + } | null; + permissions?: { + admin: boolean; + maintain?: boolean; + pull: boolean; + push: boolean; + triage?: boolean; + }; + /** @description Whether the repository is private or public. */ + private: boolean; + public?: boolean; + /** Format: uri-template */ + pulls_url: string; + pushed_at: number | string | null; + /** Format: uri-template */ + releases_url: string; + role_name?: string | null; + size: number; + ssh_url: string; + stargazers?: number; + stargazers_count: number; + /** Format: uri */ + stargazers_url: string; + /** Format: uri-template */ + statuses_url: string; + /** Format: uri */ + subscribers_url: string; + /** Format: uri */ + subscription_url: string; + /** Format: uri */ + svn_url: string; + /** Format: uri */ + tags_url: string; + /** Format: uri */ + teams_url: string; + topics: string[]; + /** Format: uri-template */ + trees_url: string; + /** Format: date-time */ + updated_at: string; + /** Format: uri */ + url: string; + /** @enum {string} */ + visibility: "public" | "private" | "internal"; + watchers: number; + watchers_count: number; + }; + sender: components["schemas"]["simple-user"]; team: components["schemas"]["webhooks_team_1"]; }; /** team deleted event */ @@ -76360,7 +79193,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -76436,6 +79272,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -76483,7 +79320,7 @@ export interface components { watchers: number; watchers_count: number; }; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; team: components["schemas"]["webhooks_team_1"]; }; /** team edited event */ @@ -76640,7 +79477,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -76716,6 +79556,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -76763,7 +79604,7 @@ export interface components { watchers: number; watchers_count: number; }; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; team: components["schemas"]["webhooks_team_1"]; }; /** team removed_from_repository event */ @@ -76889,7 +79730,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -76965,6 +79809,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -77012,7 +79857,7 @@ export interface components { watchers: number; watchers_count: number; }; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; team: components["schemas"]["webhooks_team_1"]; }; /** watch started event */ @@ -77023,7 +79868,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** workflow_dispatch event */ "webhook-workflow-dispatch": { @@ -77035,7 +79880,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; ref: string; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; workflow: string; }; /** workflow_job completed event */ @@ -77046,7 +79891,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; workflow_job: { /** Format: uri */ check_run_url: string; @@ -77151,7 +79996,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; workflow_job: { /** Format: uri */ check_run_url: string; @@ -77249,7 +80094,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; workflow_job: { /** Format: uri */ check_run_url: string; @@ -77303,7 +80148,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; workflow_job: { /** Format: uri */ check_run_url: string; @@ -77362,7 +80207,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; workflow: components["schemas"]["webhooks_workflow"]; /** Workflow Run */ workflow_run: { @@ -77402,6 +80247,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** Format: uri */ artifacts_url: string; @@ -77421,6 +80267,7 @@ export interface components { | "stale" | "success" | "timed_out" + | "startup_failure" | null; /** Format: date-time */ created_at: string; @@ -77561,6 +80408,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description Whether the repository is private or public. */ private: boolean; @@ -77735,6 +80583,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description Whether the repository is private or public. */ private: boolean; @@ -77809,6 +80658,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** Format: date-time */ updated_at: string; @@ -77832,7 +80682,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; workflow: components["schemas"]["webhooks_workflow"]; /** Workflow Run */ workflow_run: { @@ -78296,7 +81146,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; workflow: components["schemas"]["webhooks_workflow"]; /** Workflow Run */ workflow_run: { @@ -78336,6 +81186,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** Format: uri */ artifacts_url: string; @@ -78496,6 +81347,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description Whether the repository is private or public. */ private: boolean; @@ -78670,6 +81522,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description Whether the repository is private or public. */ private: boolean; @@ -78744,6 +81597,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** Format: date-time */ updated_at: string; @@ -78804,12 +81658,16 @@ export interface components { "application/json": components["schemas"]["basic-error"]; }; }; - /** @description Internal Error */ - internal_error: { + /** @description Conflict */ + conflict: { content: { "application/json": components["schemas"]["basic-error"]; }; }; + /** @description A header with no content is returned. */ + no_content: { + content: never; + }; /** @description Service unavailable */ service_unavailable: { content: { @@ -78840,8 +81698,14 @@ export interface components { "application/json": components["schemas"]["basic-error"]; }; }; - /** @description Conflict */ - conflict: { + /** @description Billing usage report response for an organization */ + billing_usage_report_org: { + content: { + "application/json": components["schemas"]["billing-usage-report"]; + }; + }; + /** @description Internal Error */ + internal_error: { content: { "application/json": components["schemas"]["basic-error"]; }; @@ -78874,14 +81738,16 @@ export interface components { }; }; }; + /** @description Copilot Usage Merics API setting is disabled at the organization or enterprise level. */ + usage_metrics_api_disabled: { + 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; }; - /** @description A header with no content is returned. */ - no_content: { - content: never; - }; /** @description Gone */ gone: { content: { @@ -78906,6 +81772,18 @@ export interface components { "application/json": components["schemas"]["basic-error"]; }; }; + /** @description Bad Request */ + code_scanning_bad_request: { + content: { + "application/json": components["schemas"]["basic-error"]; + }; + }; + /** @description Response if the repository is archived, if GitHub Advanced Security is not enabled for this repository or if rate limit is exceeded */ + code_scanning_autofix_create_forbidden: { + content: { + "application/json": components["schemas"]["basic-error"]; + }; + }; /** @description Found */ found: { content: never; @@ -78964,6 +81842,8 @@ 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 The unique identifier of the code security configuration. */ + "configuration-id": number; /** * @description A comma-separated list of states. If specified, only alerts with these states will be returned. * @@ -79006,11 +81886,7 @@ export interface components { "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. - */ + /** @description A comma-separated list of secret types to return. All default secret patterns are returned. To return experimental patterns, pass the token name(s) in the parameter. See "[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" 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; @@ -79018,6 +81894,10 @@ export interface components { "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; + /** @description A boolean value representing whether or not to filter alerts by the publicly-leaked tag being present. */ + "secret-scanning-alert-publicly-leaked"?: boolean; + /** @description A boolean value representing whether or not to filter alerts by the multi-repo tag being present. */ + "secret-scanning-alert-multi-repo"?: boolean; /** @description The unique identifier of the gist. */ "gist-id": string; /** @description The unique identifier of the comment. */ @@ -79046,8 +81926,20 @@ export interface components { "since-org"?: number; /** @description The organization name. The name is not case sensitive. */ org: string; + /** @description If specified, only return results for a single year. The value of `year` is an integer with four digits representing a year. For example, `2024`. Default value is the current year. */ + "billing-usage-report-year"?: number; + /** @description If specified, only return results for a single month. The value of `month` is an integer between `1` and `12`. */ + "billing-usage-report-month"?: number; + /** @description If specified, only return results for a single day. The value of `day` is an integer between `1` and `31`. */ + "billing-usage-report-day"?: number; + /** @description If specified, only return results for a single hour. The value of `hour` is an integer between `0` and `23`. */ + "billing-usage-report-hour"?: 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; + /** @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 The name of a self-hosted runner's custom label. */ @@ -79066,6 +81958,46 @@ export interface components { "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 type of the actor */ + "api-insights-actor-type": + | "installation" + | "classic_pat" + | "fine_grained_pat" + | "oauth_app" + | "github_app_user_to_server"; + /** @description The ID of the actor */ + "api-insights-actor-id": number; + /** @description The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ + "api-insights-min-timestamp": string; + /** @description The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ + "api-insights-max-timestamp"?: string; + /** @description The property to sort the results by. */ + "api-insights-route-stats-sort"?: ( + | "last_rate_limited_timestamp" + | "last_request_timestamp" + | "rate_limited_request_count" + | "http_method" + | "api_route" + | "total_request_count" + )[]; + /** @description Providing a substring will filter results where the API route contains the substring. This is a case-insensitive search. */ + "api-insights-api-route-substring"?: string; + /** @description The property to sort the results by. */ + "api-insights-sort"?: ( + | "last_rate_limited_timestamp" + | "last_request_timestamp" + | "rate_limited_request_count" + | "subject_name" + | "total_request_count" + )[]; + /** @description Providing a substring will filter results where the subject name contains the substring. This is a case-insensitive search. */ + "api-insights-subject-name-substring"?: string; + /** @description The ID of the user to query for stats */ + "api-insights-user-id": string; + /** @description The increment of time used to breakdown the query results (5m, 10m, 1h, etc.) */ + "api-insights-timestamp-increment": string; + /** @description Providing a substring will filter results where the actor name contains the substring. This is a case-insensitive search. */ + "api-insights-actor-name-substring"?: string; /** @description The unique identifier of the invitation. */ "invitation-id": number; /** @description The name of the codespace. */ @@ -79111,10 +82043,18 @@ export interface components { "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. */ + /** @description The custom property name */ "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 A comma-separated list of rule targets to filter by. + * If provided, only rulesets that apply to the specified targets will be returned. + * For example, `branch,tag,push`. + */ + "ruleset-targets"?: string; + /** @description The name of the ref. Cannot contain wildcard characters. Optionally prefix with `refs/heads/` to limit to branches or `refs/tags/` to limit to tags. Omit the prefix to search across all refs. When specified, only rule evaluations triggered for this ref will be returned. */ + "ref-in-query"?: string; + /** @description The name of the repository to filter on. */ + "repository-name-in-query"?: string; /** * @description The time period to filter by. * @@ -79233,6 +82173,8 @@ export interface components { 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"]; + /** @description The number of the pull request for the results you want to list. */ + "pr-alias"?: number; /** @description The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation. */ "alert-number": components["schemas"]["alert-number"]; /** @description The SHA of the commit. */ @@ -79281,8 +82223,6 @@ export interface components { "asset-id": number; /** @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; /** @description The unique identifier of the tag protection. */ "tag-protection-id": number; /** @description The time frame to display results for. */ @@ -79399,13 +82339,23 @@ export interface operations { * 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 If specified, only return advisories that have an EPSS percentage score that matches the provided value. + * The EPSS percentage represents the likelihood of a CVE being exploited. + */ + epss_percentage?: string; + /** + * @description If specified, only return advisories that have an EPSS percentile score that matches the provided value. + * The EPSS percentile represents the relative rank of the CVE's likelihood of being exploited compared to other CVEs. + */ + epss_percentile?: string; before?: components["parameters"]["pagination-before"]; after?: components["parameters"]["pagination-after"]; 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"; + sort?: "updated" | "published" | "epss_percentage" | "epss_percentile"; }; }; responses: { @@ -79540,7 +82490,6 @@ export interface operations { query?: { per_page?: components["parameters"]["per-page"]; cursor?: components["parameters"]["cursor"]; - redelivery?: boolean; }; }; responses: { @@ -80108,8 +83057,6 @@ export interface operations { * * 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": { @@ -80189,7 +83136,7 @@ export interface operations { }; /** * 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. + * @description OAuth and GitHub application owners can revoke a grant for their application and a specific user. You must 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": { @@ -80216,7 +83163,7 @@ export interface operations { }; /** * 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`. + * @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. Invalid tokens will return `404 NOT FOUND`. */ "apps/check-token": { parameters: { @@ -80245,7 +83192,7 @@ export interface operations { }; /** * 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. + * @description OAuth or GitHub application owners can revoke a single token for an OAuth application or a GitHub application with an OAuth authorization. */ "apps/delete-token": { parameters: { @@ -80271,7 +83218,7 @@ export interface operations { }; /** * 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`. + * @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. Invalid tokens will return `404 NOT FOUND`. */ "apps/reset-token": { parameters: { @@ -80304,10 +83251,6 @@ export interface operations { * 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: { @@ -80361,7 +83304,8 @@ export interface operations { }; /** * 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`). + * @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: { @@ -80560,48 +83504,469 @@ export interface operations { }; }; /** - * Get a summary of Copilot usage for enterprise members - * @description **Note**: This endpoint is in beta and is subject to change. + * Get code security configurations for an enterprise + * @description Lists all code security configurations available in an enterprise. * - * 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 authenticated user must be an administrator of the enterprise in order to use this endpoint. * - * 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. + * OAuth app tokens and personal access tokens (classic) need the `read:enterprise` scope to use this endpoint. + */ + "code-security/get-configurations-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/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + per_page?: number; + before?: components["parameters"]["pagination-before"]; + after?: components["parameters"]["pagination-after"]; + }; + path: { + enterprise: components["parameters"]["enterprise"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["code-security-configuration"][]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + /** + * Create a code security configuration for an enterprise + * @description Creates a code security configuration in an 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. + */ + "code-security/create-configuration-for-enterprise": { + parameters: { + path: { + enterprise: components["parameters"]["enterprise"]; + }; + }; + requestBody: { + content: { + "application/json": { + /** @description The name of the code security configuration. Must be unique within the enterprise. */ + name: string; + /** @description A description of the code security configuration */ + description: string; + /** + * @description The enablement status of GitHub Advanced Security + * @default disabled + * @enum {string} + */ + advanced_security?: "enabled" | "disabled"; + /** + * @description The enablement status of Dependency Graph + * @default enabled + * @enum {string} + */ + dependency_graph?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Automatic dependency submission + * @default disabled + * @enum {string} + */ + dependency_graph_autosubmit_action?: + | "enabled" + | "disabled" + | "not_set"; + /** @description Feature options for Automatic dependency submission */ + dependency_graph_autosubmit_action_options?: { + /** + * @description Whether to use runners labeled with 'dependency-submission' or standard GitHub runners. + * @default false + */ + labeled_runners?: boolean; + }; + /** + * @description The enablement status of Dependabot alerts + * @default disabled + * @enum {string} + */ + dependabot_alerts?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Dependabot security updates + * @default disabled + * @enum {string} + */ + dependabot_security_updates?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of code scanning default setup + * @default disabled + * @enum {string} + */ + code_scanning_default_setup?: "enabled" | "disabled" | "not_set"; + code_scanning_default_setup_options?: components["schemas"]["code-scanning-default-setup-options"]; + /** + * @description The enablement status of secret scanning + * @default disabled + * @enum {string} + */ + secret_scanning?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning push protection + * @default disabled + * @enum {string} + */ + secret_scanning_push_protection?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning validity checks + * @default disabled + * @enum {string} + */ + secret_scanning_validity_checks?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning non provider patterns + * @default disabled + * @enum {string} + */ + secret_scanning_non_provider_patterns?: + | "enabled" + | "disabled" + | "not_set"; + /** + * @description The enablement status of private vulnerability reporting + * @default disabled + * @enum {string} + */ + private_vulnerability_reporting?: "enabled" | "disabled" | "not_set"; + /** + * @description The enforcement status for a security configuration + * @default enforced + * @enum {string} + */ + enforcement?: "enforced" | "unenforced"; + }; + }; + }; + responses: { + /** @description Successfully created code security configuration */ + 201: { + content: { + "application/json": components["schemas"]["code-security-configuration"]; + }; + }; + 400: components["responses"]["bad_request"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + /** + * Get default code security configurations for an enterprise + * @description Lists the default code security configurations for an 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 `read:enterprise` scope to use this endpoint. + */ + "code-security/get-default-configurations-for-enterprise": { + parameters: { + path: { + enterprise: components["parameters"]["enterprise"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["code-security-default-configurations"]; + }; + }; + }; + }; + /** + * Retrieve a code security configuration of an enterprise + * @description Gets a code security configuration available in an 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 `read:enterprise` scope to use this endpoint. + */ + "code-security/get-single-configuration-for-enterprise": { + parameters: { + path: { + enterprise: components["parameters"]["enterprise"]; + configuration_id: components["parameters"]["configuration-id"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["code-security-configuration"]; + }; + }; + 304: components["responses"]["not_modified"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + /** + * Delete a code security configuration for an enterprise + * @description Deletes a code security configuration from an enterprise. + * Repositories attached to the configuration will retain their settings but will no longer be associated with + * the configuration. * - * Only the owners and billing managers of enterprises with a Copilot Business or Enterprise subscription can view Copilot usage - * metrics for the enterprise. + * The authenticated user must be an administrator for the enterprise 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. + * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. */ - "copilot/usage-metrics-for-enterprise": { + "code-security/delete-configuration-for-enterprise": { + parameters: { + path: { + enterprise: components["parameters"]["enterprise"]; + configuration_id: components["parameters"]["configuration-id"]; + }; + }; + responses: { + 204: components["responses"]["no_content"]; + 400: components["responses"]["bad_request"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; + }; + }; + /** + * Update a custom code security configuration for an enterprise + * @description Updates a code security configuration in an 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. + */ + "code-security/update-enterprise-configuration": { + parameters: { + path: { + enterprise: components["parameters"]["enterprise"]; + configuration_id: components["parameters"]["configuration-id"]; + }; + }; + requestBody: { + content: { + "application/json": { + /** @description The name of the code security configuration. Must be unique across the enterprise. */ + name?: string; + /** @description A description of the code security configuration */ + description?: string; + /** + * @description The enablement status of GitHub Advanced Security. Must be set to enabled if you want to enable any GHAS settings. + * @enum {string} + */ + advanced_security?: "enabled" | "disabled"; + /** + * @description The enablement status of Dependency Graph + * @enum {string} + */ + dependency_graph?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Automatic dependency submission + * @enum {string} + */ + dependency_graph_autosubmit_action?: + | "enabled" + | "disabled" + | "not_set"; + /** @description Feature options for Automatic dependency submission */ + dependency_graph_autosubmit_action_options?: { + /** @description Whether to use runners labeled with 'dependency-submission' or standard GitHub runners. */ + labeled_runners?: boolean; + }; + /** + * @description The enablement status of Dependabot alerts + * @enum {string} + */ + dependabot_alerts?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Dependabot security updates + * @enum {string} + */ + dependabot_security_updates?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of code scanning default setup + * @enum {string} + */ + code_scanning_default_setup?: "enabled" | "disabled" | "not_set"; + code_scanning_default_setup_options?: components["schemas"]["code-scanning-default-setup-options"]; + /** + * @description The enablement status of secret scanning + * @enum {string} + */ + secret_scanning?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning push protection + * @enum {string} + */ + secret_scanning_push_protection?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning validity checks + * @enum {string} + */ + secret_scanning_validity_checks?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning non-provider patterns + * @enum {string} + */ + secret_scanning_non_provider_patterns?: + | "enabled" + | "disabled" + | "not_set"; + /** + * @description The enablement status of private vulnerability reporting + * @enum {string} + */ + private_vulnerability_reporting?: "enabled" | "disabled" | "not_set"; + /** + * @description The enforcement status for a security configuration + * @enum {string} + */ + enforcement?: "enforced" | "unenforced"; + }; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["code-security-configuration"]; + }; + }; + 304: components["responses"]["not_modified"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; + }; + }; + /** + * Attach an enterprise configuration to repositories + * @description Attaches an enterprise code security configuration to repositories. If the repositories specified are already attached to a configuration, they will be re-attached to the provided configuration. + * + * If insufficient GHAS licenses are available to attach the configuration to a repository, only free features will be enabled. + * + * The authenticated user must be an administrator for the enterprise to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + */ + "code-security/attach-enterprise-configuration": { + parameters: { + path: { + enterprise: components["parameters"]["enterprise"]; + configuration_id: components["parameters"]["configuration-id"]; + }; + }; + requestBody: { + content: { + "application/json": { + /** + * @description The type of repositories to attach the configuration to. `selected` means the configuration will be attached to only the repositories specified by `selected_repository_ids` + * @enum {string} + */ + scope: "all" | "all_without_configurations"; + }; + }; + }; + responses: { + 202: components["responses"]["accepted"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; + }; + }; + /** + * Set a code security configuration as a default for an enterprise + * @description Sets a code security configuration as a default to be applied to new repositories in your enterprise. + * + * This configuration will be applied by default to the matching repository type when created, but only for organizations within the enterprise that do not already have a default code security configuration set. + * + * The authenticated user must be an administrator for the enterprise to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + */ + "code-security/set-configuration-as-default-for-enterprise": { + parameters: { + path: { + enterprise: components["parameters"]["enterprise"]; + configuration_id: components["parameters"]["configuration-id"]; + }; + }; + requestBody: { + content: { + "application/json": { + /** + * @description Specify which types of repository this security configuration should be applied to by default. + * @enum {string} + */ + default_for_new_repos?: + | "all" + | "none" + | "private_and_internal" + | "public"; + }; + }; + }; + responses: { + /** @description Default successfully changed. */ + 200: { + content: { + "application/json": { + /** + * @description Specifies which types of repository this security configuration is applied to by default. + * @enum {string} + */ + default_for_new_repos?: + | "all" + | "none" + | "private_and_internal" + | "public"; + configuration?: components["schemas"]["code-security-configuration"]; + }; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + /** + * Get repositories associated with an enterprise code security configuration + * @description Lists the repositories associated with an enterprise code security configuration in an organization. + * + * 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 `read:enterprise` scope to use this endpoint. + */ + "code-security/get-repositories-for-enterprise-configuration": { parameters: { query?: { - /** @description Show usage metrics since this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). Maximum value is 28 days ago. */ - 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; - 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)." */ + /** @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; + before?: components["parameters"]["pagination-before"]; + after?: components["parameters"]["pagination-after"]; + /** + * @description A comma-separated list of statuses. If specified, only repositories with these attachment statuses will be returned. + * + * Can be: `all`, `attached`, `attaching`, `removed`, `enforced`, `failed`, `updating`, `removed_by_enterprise` + */ + status?: string; }; path: { enterprise: components["parameters"]["enterprise"]; + configuration_id: components["parameters"]["configuration-id"]; }; }; responses: { /** @description Response */ 200: { content: { - "application/json": components["schemas"]["copilot-usage-metrics"][]; + "application/json": components["schemas"]["code-security-configuration-repositories"][]; }; }; - 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; - 500: components["responses"]["internal_error"]; }; }; /** @@ -80669,6 +84034,8 @@ export interface operations { before?: components["parameters"]["pagination-before"]; after?: components["parameters"]["pagination-after"]; validity?: components["parameters"]["secret-scanning-alert-validity"]; + is_publicly_leaked?: components["parameters"]["secret-scanning-alert-publicly-leaked"]; + is_multi_repo?: components["parameters"]["secret-scanning-alert-multi-repo"]; }; path: { enterprise: components["parameters"]["enterprise"]; @@ -80690,7 +84057,8 @@ export interface operations { }; /** * 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. + * @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-public-events": { parameters: { @@ -80725,7 +84093,8 @@ export interface operations { * * 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/authentication/authenticating-to-the-rest-api#using-basic-authentication) since current feed URIs use the older, non revocable auth tokens. */ "activity/get-feeds": { responses: { @@ -80767,7 +84136,8 @@ export interface operations { * 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. */ "gists/create": { requestBody: { @@ -81378,10 +84748,8 @@ export interface operations { * 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)." * @@ -81538,7 +84906,7 @@ export interface operations { * 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/authentication/authenticating-to-the-rest-api#using-basic-authentication) with their client ID and client secret to access this endpoint. */ "apps/get-subscription-plan-for-account": { parameters: { @@ -81566,7 +84934,7 @@ export interface operations { * 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/authentication/authenticating-to-the-rest-api#using-basic-authentication) with their client ID and client secret to access this endpoint. */ "apps/list-plans": { parameters: { @@ -81593,7 +84961,7 @@ export interface operations { * 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/authentication/authenticating-to-the-rest-api#using-basic-authentication) with their client ID and client secret to access this endpoint. */ "apps/list-accounts-for-plan": { parameters: { @@ -81627,7 +84995,7 @@ export interface operations { * 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/authentication/authenticating-to-the-rest-api#using-basic-authentication) with their client ID and client secret to access this endpoint. */ "apps/get-subscription-plan-for-account-stubbed": { parameters: { @@ -81653,7 +85021,7 @@ export interface operations { * 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/authentication/authenticating-to-the-rest-api#using-basic-authentication) with their client ID and client secret to access this endpoint. */ "apps/list-plans-stubbed": { parameters: { @@ -81679,7 +85047,7 @@ export interface operations { * 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/authentication/authenticating-to-the-rest-api#using-basic-authentication) with their client ID and client secret to access this endpoint. */ "apps/list-accounts-for-plan-stubbed": { parameters: { @@ -81715,7 +85083,8 @@ export interface operations { * * 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. */ "meta/get": { responses: { @@ -81728,7 +85097,11 @@ export interface operations { 304: components["responses"]["not_modified"]; }; }; - /** List public events for a network of repositories */ + /** + * List public events for a network of repositories + * @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-public-events-for-repo-network": { parameters: { query?: { @@ -81984,7 +85357,8 @@ export interface operations { * 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. */ "orgs/list": { parameters: { @@ -82007,6 +85381,32 @@ export interface operations { 304: components["responses"]["not_modified"]; }; }; + /** + * Get billing usage report for an organization + * @description Gets a report of the total usage for an organization. To use this endpoint, you must be an administrator of an organization within an enterprise or an organization account. + * + * **Note:** This endpoint is only available to organizations with access to the enhanced billing platform. For more information, see "[About the enhanced billing platform](https://docs.github.com/billing/using-the-new-billing-platform)." + */ + "billing/get-github-billing-usage-report-org": { + parameters: { + query?: { + year?: components["parameters"]["billing-usage-report-year"]; + month?: components["parameters"]["billing-usage-report-month"]; + day?: components["parameters"]["billing-usage-report-day"]; + hour?: components["parameters"]["billing-usage-report-hour"]; + }; + path: { + org: components["parameters"]["org"]; + }; + }; + responses: { + 200: components["responses"]["billing_usage_report_org"]; + 400: components["responses"]["bad_request"]; + 403: components["responses"]["forbidden"]; + 500: components["responses"]["internal_error"]; + 503: components["responses"]["service_unavailable"]; + }; + }; /** * Get an organization * @description Gets information about an organization. @@ -82015,17 +85415,6 @@ export interface operations { * * 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. @@ -82070,20 +85459,13 @@ export interface operations { }; /** * 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. + * @description > [!WARNING] + * > **Closing down 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). * - * 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: + * > [!WARNING] + * > **Closing down notice:** Code security product enablement for new repositories through the organization API is closing down. Please use [code security configurations](https://docs.github.com/rest/code-security/configurations#set-a-code-security-configuration-as-a-default-for-an-organization) to set defaults instead. For more information on setting a default security configuration, see the [changelog](https://github.blog/changelog/2024-07-09-sunsetting-security-settings-defaults-parameters-in-the-organizations-rest-api/). * - * - 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)." + * Updates the organization's profile and member privileges. * * The authenticated user must be an organization owner to use this endpoint. * @@ -82135,7 +85517,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 closing down 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"; @@ -82167,7 +85549,10 @@ export interface operations { /** @example "http://github.blog" */ blog?: string; /** - * @description Whether GitHub Advanced Security is automatically enabled for new repositories. + * @deprecated + * @description **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + * + * Whether GitHub Advanced Security is automatically enabled for new repositories and repositories transferred to this 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)." * @@ -82175,7 +85560,10 @@ export interface operations { */ advanced_security_enabled_for_new_repositories?: boolean; /** - * @description Whether Dependabot alerts is automatically enabled for new repositories. + * @deprecated + * @description **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + * + * Whether Dependabot alerts are automatically enabled for new repositories and repositories transferred to this 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)." * @@ -82183,7 +85571,10 @@ export interface operations { */ dependabot_alerts_enabled_for_new_repositories?: boolean; /** - * @description Whether Dependabot security updates is automatically enabled for new repositories. + * @deprecated + * @description **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + * + * Whether Dependabot security updates are automatically enabled for new repositories and repositories transferred to this 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)." * @@ -82191,7 +85582,10 @@ export interface operations { */ dependabot_security_updates_enabled_for_new_repositories?: boolean; /** - * @description Whether dependency graph is automatically enabled for new repositories. + * @deprecated + * @description **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + * + * Whether dependency graph is automatically enabled for new repositories and repositories transferred to this 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)." * @@ -82199,7 +85593,10 @@ export interface operations { */ dependency_graph_enabled_for_new_repositories?: boolean; /** - * @description Whether secret scanning is automatically enabled for new repositories. + * @deprecated + * @description **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + * + * Whether secret scanning is automatically enabled for new repositories and repositories transferred to this 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)." * @@ -82207,7 +85604,10 @@ export interface operations { */ secret_scanning_enabled_for_new_repositories?: boolean; /** - * @description Whether secret scanning push protection is automatically enabled for new repositories. + * @deprecated + * @description **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + * + * Whether secret scanning push protection is automatically enabled for new repositories and repositories transferred to this 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)." * @@ -82218,6 +85618,8 @@ export interface operations { secret_scanning_push_protection_custom_link_enabled?: boolean; /** @description If `secret_scanning_push_protection_custom_link_enabled` is true, the URL that will be displayed to contributors who are blocked from pushing a secret. */ secret_scanning_push_protection_custom_link?: string; + /** @description Controls whether or not deploy keys may be added and used for repositories in the organization. */ + deploy_keys_enabled_for_repositories?: boolean; }; }; }; @@ -82583,6 +85985,376 @@ export interface operations { }; }; }; + /** + * 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?: { + per_page?: components["parameters"]["per-page"]; + page?: components["parameters"]["page"]; + visible_to_repository?: components["parameters"]["visible-to-repository"]; + }; + path: { + org: components["parameters"]["org"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": { + total_count: number; + runner_groups: components["schemas"]["runner-groups-org"][]; + }; + }; + }; + }; + }; + /** + * 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: { + path: { + org: components["parameters"]["org"]; + }; + }; + requestBody: { + content: { + "application/json": { + /** @description Name of the runner group. */ + name: string; + /** + * @description Visibility of a runner group. You can select all repositories, select individual repositories, or limit access to private repositories. + * @default all + * @enum {string} + */ + visibility?: "selected" | "all" | "private"; + /** @description List of repository IDs that can access the runner group. */ + selected_repository_ids?: number[]; + /** @description List of runner IDs to add to the runner group. */ + runners?: number[]; + /** + * @description Whether the runner group can be used by `public` repositories. + * @default false + */ + allows_public_repositories?: 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; + /** @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[]; + }; + }; + }; + responses: { + /** @description Response */ + 201: { + 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: { + path: { + org: components["parameters"]["org"]; + runner_group_id: components["parameters"]["runner-group-id"]; + }; + }; + responses: { + /** @description Response */ + 200: { + 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: { + path: { + org: components["parameters"]["org"]; + runner_group_id: components["parameters"]["runner-group-id"]; + }; + }; + responses: { + /** @description Response */ + 204: { + 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: { + path: { + org: components["parameters"]["org"]; + runner_group_id: components["parameters"]["runner-group-id"]; + }; + }; + requestBody: { + content: { + "application/json": { + /** @description Name of the runner group. */ + name: string; + /** + * @description Visibility of a runner group. You can select all repositories, select individual repositories, or all private repositories. + * @enum {string} + */ + visibility?: "selected" | "all" | "private"; + /** + * @description Whether the runner group can be used by `public` repositories. + * @default false + */ + allows_public_repositories?: 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; + /** @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[]; + }; + }; + }; + responses: { + /** @description Response */ + 200: { + 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?: { + page?: components["parameters"]["page"]; + per_page?: components["parameters"]["per-page"]; + }; + path: { + org: components["parameters"]["org"]; + runner_group_id: components["parameters"]["runner-group-id"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": { + total_count: number; + repositories: components["schemas"]["minimal-repository"][]; + }; + }; + }; + }; + }; + /** + * 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: { + path: { + org: components["parameters"]["org"]; + runner_group_id: components["parameters"]["runner-group-id"]; + }; + }; + requestBody: { + content: { + "application/json": { + /** @description List of repository IDs that can access the runner group. */ + selected_repository_ids: number[]; + }; + }; + }; + responses: { + /** @description Response */ + 204: { + 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: { + path: { + org: components["parameters"]["org"]; + runner_group_id: components["parameters"]["runner-group-id"]; + repository_id: components["parameters"]["repository-id"]; + }; + }; + responses: { + /** @description Response */ + 204: { + 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: { + path: { + org: components["parameters"]["org"]; + runner_group_id: components["parameters"]["runner-group-id"]; + repository_id: components["parameters"]["repository-id"]; + }; + }; + responses: { + /** @description Response */ + 204: { + 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?: { + per_page?: components["parameters"]["per-page"]; + page?: components["parameters"]["page"]; + }; + path: { + org: components["parameters"]["org"]; + runner_group_id: components["parameters"]["runner-group-id"]; + }; + }; + responses: { + /** @description Response */ + 200: { + headers: { + Link: components["headers"]["link"]; + }; + content: { + "application/json": { + total_count: number; + runners: components["schemas"]["runner"][]; + }; + }; + }; + }; + }; + /** + * 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: { + path: { + org: components["parameters"]["org"]; + runner_group_id: components["parameters"]["runner-group-id"]; + }; + }; + requestBody: { + content: { + "application/json": { + /** @description List of runner IDs to add to the runner group. */ + runners: number[]; + }; + }; + }; + responses: { + /** @description Response */ + 204: { + 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: { + path: { + org: components["parameters"]["org"]; + runner_group_id: components["parameters"]["runner-group-id"]; + runner_id: components["parameters"]["runner-id"]; + }; + }; + responses: { + /** @description Response */ + 204: { + 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: { + path: { + org: components["parameters"]["org"]; + runner_group_id: components["parameters"]["runner-group-id"]; + runner_id: components["parameters"]["runner-id"]; + }; + }; + responses: { + /** @description Response */ + 204: { + content: never; + }; + }; + }; /** * List self-hosted runners for an organization * @description Lists all self-hosted runners configured in an organization. @@ -83536,6 +87308,54 @@ export interface operations { }; }; }; + /** + * List attestations + * @description List a collection of artifact attestations with a given subject digest that are associated with repositories owned by an organization. + * + * The collection of attestations returned by this endpoint is filtered according to the authenticated user's permissions; if the authenticated user cannot read a repository, the attestations associated with that repository will not be included in the response. In addition, when using a fine-grained access token the `attestations:read` permission is required. + * + * **Please note:** in order to offer meaningful security benefits, an attestation's signature and timestamps **must** be cryptographically verified, and the identity of the attestation signer **must** be validated. Attestations can be verified using the [GitHub CLI `attestation verify` command](https://cli.github.com/manual/gh_attestation_verify). For more information, see [our guide on how to use artifact attestations to establish a build's provenance](https://docs.github.com/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds). + */ + "orgs/list-attestations": { + parameters: { + query?: { + per_page?: components["parameters"]["per-page"]; + before?: components["parameters"]["pagination-before"]; + after?: components["parameters"]["pagination-after"]; + }; + path: { + org: components["parameters"]["org"]; + /** @description The parameter should be set to the attestation's subject's SHA256 digest, in the form `sha256:HEX_DIGEST`. */ + subject_digest: string; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": { + attestations?: { + /** + * @description The attestation's Sigstore Bundle. + * Refer to the [Sigstore Bundle Specification](https://github.com/sigstore/protobuf-specs/blob/main/protos/sigstore_bundle.proto) for more information. + */ + bundle?: { + mediaType?: string; + verificationMaterial?: { + [key: string]: unknown; + }; + dsseEnvelope?: { + [key: string]: unknown; + }; + }; + repository_id?: number; + bundle_url?: string; + }[]; + }; + }; + }; + }; + }; /** * List users blocked by an organization * @description List the users blocked by an organization. @@ -83663,6 +87483,546 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; + /** + * Get code security configurations for an organization + * @description Lists all code security configurations available in an 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 `write:org` scope to use this endpoint. + */ + "code-security/get-configurations-for-org": { + parameters: { + query?: { + /** @description The target type of the code security configuration */ + target_type?: "global" | "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?: number; + before?: components["parameters"]["pagination-before"]; + after?: components["parameters"]["pagination-after"]; + }; + path: { + org: components["parameters"]["org"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["code-security-configuration"][]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + /** + * Create a code security configuration + * @description Creates a code security configuration in an 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 `write:org` scope to use this endpoint. + */ + "code-security/create-configuration": { + parameters: { + path: { + org: components["parameters"]["org"]; + }; + }; + requestBody: { + content: { + "application/json": { + /** @description The name of the code security configuration. Must be unique within the organization. */ + name: string; + /** @description A description of the code security configuration */ + description: string; + /** + * @description The enablement status of GitHub Advanced Security + * @default disabled + * @enum {string} + */ + advanced_security?: "enabled" | "disabled"; + /** + * @description The enablement status of Dependency Graph + * @default enabled + * @enum {string} + */ + dependency_graph?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Automatic dependency submission + * @default disabled + * @enum {string} + */ + dependency_graph_autosubmit_action?: + | "enabled" + | "disabled" + | "not_set"; + /** @description Feature options for Automatic dependency submission */ + dependency_graph_autosubmit_action_options?: { + /** + * @description Whether to use runners labeled with 'dependency-submission' or standard GitHub runners. + * @default false + */ + labeled_runners?: boolean; + }; + /** + * @description The enablement status of Dependabot alerts + * @default disabled + * @enum {string} + */ + dependabot_alerts?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Dependabot security updates + * @default disabled + * @enum {string} + */ + dependabot_security_updates?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of code scanning default setup + * @default disabled + * @enum {string} + */ + code_scanning_default_setup?: "enabled" | "disabled" | "not_set"; + code_scanning_default_setup_options?: components["schemas"]["code-scanning-default-setup-options"]; + /** + * @description The enablement status of secret scanning + * @default disabled + * @enum {string} + */ + secret_scanning?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning push protection + * @default disabled + * @enum {string} + */ + secret_scanning_push_protection?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning delegated bypass + * @default disabled + * @enum {string} + */ + secret_scanning_delegated_bypass?: "enabled" | "disabled" | "not_set"; + /** @description Feature options for secret scanning delegated bypass */ + secret_scanning_delegated_bypass_options?: { + /** @description The bypass reviewers for secret scanning delegated bypass */ + reviewers?: { + /** @description The ID of the team or role selected as a bypass reviewer */ + reviewer_id: number; + /** + * @description The type of the bypass reviewer + * @enum {string} + */ + reviewer_type: "TEAM" | "ROLE"; + }[]; + }; + /** + * @description The enablement status of secret scanning validity checks + * @default disabled + * @enum {string} + */ + secret_scanning_validity_checks?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning non provider patterns + * @default disabled + * @enum {string} + */ + secret_scanning_non_provider_patterns?: + | "enabled" + | "disabled" + | "not_set"; + /** + * @description The enablement status of private vulnerability reporting + * @default disabled + * @enum {string} + */ + private_vulnerability_reporting?: "enabled" | "disabled" | "not_set"; + /** + * @description The enforcement status for a security configuration + * @default enforced + * @enum {string} + */ + enforcement?: "enforced" | "unenforced"; + }; + }; + }; + responses: { + /** @description Successfully created code security configuration */ + 201: { + content: { + "application/json": components["schemas"]["code-security-configuration"]; + }; + }; + }; + }; + /** + * Get default code security configurations + * @description Lists the default code security configurations for an 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 `write:org` scope to use this endpoint. + */ + "code-security/get-default-configurations": { + parameters: { + path: { + org: components["parameters"]["org"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["code-security-default-configurations"]; + }; + }; + 304: components["responses"]["not_modified"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + /** + * Detach configurations from repositories + * @description Detach code security configuration(s) from a set of repositories. + * Repositories will retain their settings but will no longer be associated with the configuration. + * + * 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 `write:org` scope to use this endpoint. + */ + "code-security/detach-configuration": { + parameters: { + path: { + org: components["parameters"]["org"]; + }; + }; + requestBody: { + content: { + "application/json": { + /** @description An array of repository IDs to detach from configurations. */ + selected_repository_ids?: number[]; + }; + }; + }; + responses: { + 204: components["responses"]["no_content"]; + 400: components["responses"]["bad_request"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; + }; + }; + /** + * Get a code security configuration + * @description Gets a code security configuration available in an 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 `write:org` scope to use this endpoint. + */ + "code-security/get-configuration": { + parameters: { + path: { + org: components["parameters"]["org"]; + configuration_id: components["parameters"]["configuration-id"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["code-security-configuration"]; + }; + }; + 304: components["responses"]["not_modified"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + /** + * Delete a code security configuration + * @description Deletes the desired code security configuration from an organization. + * Repositories attached to the configuration will retain their settings but will no longer be associated with + * the configuration. + * + * 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 `write:org` scope to use this endpoint. + */ + "code-security/delete-configuration": { + parameters: { + path: { + org: components["parameters"]["org"]; + configuration_id: components["parameters"]["configuration-id"]; + }; + }; + responses: { + 204: components["responses"]["no_content"]; + 400: components["responses"]["bad_request"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; + }; + }; + /** + * Update a code security configuration + * @description Updates a code security configuration in an 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 `write:org` scope to use this endpoint. + */ + "code-security/update-configuration": { + parameters: { + path: { + org: components["parameters"]["org"]; + configuration_id: components["parameters"]["configuration-id"]; + }; + }; + requestBody: { + content: { + "application/json": { + /** @description The name of the code security configuration. Must be unique within the organization. */ + name?: string; + /** @description A description of the code security configuration */ + description?: string; + /** + * @description The enablement status of GitHub Advanced Security + * @enum {string} + */ + advanced_security?: "enabled" | "disabled"; + /** + * @description The enablement status of Dependency Graph + * @enum {string} + */ + dependency_graph?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Automatic dependency submission + * @enum {string} + */ + dependency_graph_autosubmit_action?: + | "enabled" + | "disabled" + | "not_set"; + /** @description Feature options for Automatic dependency submission */ + dependency_graph_autosubmit_action_options?: { + /** @description Whether to use runners labeled with 'dependency-submission' or standard GitHub runners. */ + labeled_runners?: boolean; + }; + /** + * @description The enablement status of Dependabot alerts + * @enum {string} + */ + dependabot_alerts?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Dependabot security updates + * @enum {string} + */ + dependabot_security_updates?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of code scanning default setup + * @enum {string} + */ + code_scanning_default_setup?: "enabled" | "disabled" | "not_set"; + code_scanning_default_setup_options?: components["schemas"]["code-scanning-default-setup-options"]; + /** + * @description The enablement status of secret scanning + * @enum {string} + */ + secret_scanning?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning push protection + * @enum {string} + */ + secret_scanning_push_protection?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning delegated bypass + * @enum {string} + */ + secret_scanning_delegated_bypass?: "enabled" | "disabled" | "not_set"; + /** @description Feature options for secret scanning delegated bypass */ + secret_scanning_delegated_bypass_options?: { + /** @description The bypass reviewers for secret scanning delegated bypass */ + reviewers?: { + /** @description The ID of the team or role selected as a bypass reviewer */ + reviewer_id: number; + /** + * @description The type of the bypass reviewer + * @enum {string} + */ + reviewer_type: "TEAM" | "ROLE"; + }[]; + }; + /** + * @description The enablement status of secret scanning validity checks + * @enum {string} + */ + secret_scanning_validity_checks?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning non-provider patterns + * @enum {string} + */ + secret_scanning_non_provider_patterns?: + | "enabled" + | "disabled" + | "not_set"; + /** + * @description The enablement status of private vulnerability reporting + * @enum {string} + */ + private_vulnerability_reporting?: "enabled" | "disabled" | "not_set"; + /** + * @description The enforcement status for a security configuration + * @enum {string} + */ + enforcement?: "enforced" | "unenforced"; + }; + }; + }; + responses: { + /** @description Response when a configuration is updated */ + 200: { + content: { + "application/json": components["schemas"]["code-security-configuration"]; + }; + }; + /** @description Response when no new updates are made */ + 204: { + content: never; + }; + }; + }; + /** + * Attach a configuration to repositories + * @description Attach a code security configuration to a set of repositories. If the repositories specified are already attached to a configuration, they will be re-attached to the provided configuration. + * + * If insufficient GHAS licenses are available to attach the configuration to a repository, only free features will be enabled. + * + * 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 `write:org` scope to use this endpoint. + */ + "code-security/attach-configuration": { + parameters: { + path: { + org: components["parameters"]["org"]; + configuration_id: components["parameters"]["configuration-id"]; + }; + }; + requestBody: { + content: { + "application/json": { + /** + * @description The type of repositories to attach the configuration to. `selected` means the configuration will be attached to only the repositories specified by `selected_repository_ids` + * @enum {string} + */ + scope: + | "all" + | "all_without_configurations" + | "public" + | "private_or_internal" + | "selected"; + /** @description An array of repository IDs to attach the configuration to. You can only provide a list of repository ids when the `scope` is set to `selected`. */ + selected_repository_ids?: number[]; + }; + }; + }; + responses: { + 202: components["responses"]["accepted"]; + }; + }; + /** + * Set a code security configuration as a default for an organization + * @description Sets a code security configuration as a default to be applied to new repositories in your organization. + * + * This configuration will be applied to the matching repository type (all, none, public, private and internal) by default when they are created. + * + * 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 `write:org` scope to use this endpoint. + */ + "code-security/set-configuration-as-default": { + parameters: { + path: { + org: components["parameters"]["org"]; + configuration_id: components["parameters"]["configuration-id"]; + }; + }; + requestBody: { + content: { + "application/json": { + /** + * @description Specify which types of repository this security configuration should be applied to by default. + * @enum {string} + */ + default_for_new_repos?: + | "all" + | "none" + | "private_and_internal" + | "public"; + }; + }; + }; + responses: { + /** @description Default successfully changed. */ + 200: { + content: { + "application/json": { + /** + * @description Specifies which types of repository this security configuration is applied to by default. + * @enum {string} + */ + default_for_new_repos?: + | "all" + | "none" + | "private_and_internal" + | "public"; + configuration?: components["schemas"]["code-security-configuration"]; + }; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + /** + * Get repositories associated with a code security configuration + * @description Lists the repositories associated with a code security configuration in an 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 `write:org` scope to use this endpoint. + */ + "code-security/get-repositories-for-configuration": { + parameters: { + 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?: number; + before?: components["parameters"]["pagination-before"]; + after?: components["parameters"]["pagination-after"]; + /** + * @description A comma-separated list of statuses. If specified, only repositories with these attachment statuses will be returned. + * + * Can be: `all`, `attached`, `attaching`, `detached`, `removed`, `enforced`, `failed`, `updating`, `removed_by_enterprise` + */ + status?: string; + }; + path: { + org: components["parameters"]["org"]; + configuration_id: components["parameters"]["configuration-id"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["code-security-configuration-repositories"][]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; /** * List codespaces for the organization * @description Lists the codespaces associated to a specified organization. @@ -84085,15 +88445,16 @@ export interface operations { }; /** * Get Copilot seat information and settings for an organization - * @description **Note**: This endpoint is in beta and is subject to change. + * @description > [!NOTE] + * > This endpoint is in public preview 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)". + * and feature 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 view details about the organization's Copilot Business or Copilot 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 either the `manage_billing:copilot` or `read:org` scopes to use this endpoint. */ "copilot/get-copilot-organization-details": { parameters: { @@ -84120,13 +88481,16 @@ export interface operations { }; /** * List all Copilot seat assignments for an organization - * @description **Note**: This endpoint is in beta and is subject to change. + * @description > [!NOTE] + * > This endpoint is in public preview 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 seats for which an organization with a Copilot Business or Copilot Enterprise subscription is currently being billed. + * Only organization owners can view assigned seats. * - * Only organization owners can configure and view details about the organization's Copilot Business or Enterprise subscription. + * Each seat object contains information about the assigned user's most recent Copilot activity. Users must have telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`. + * For more information about activity data, see "[Reviewing user activity data for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-user-activity-data-for-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 either the `manage_billing:copilot` or `read:org` scopes to use this endpoint. */ "copilot/list-copilot-seats": { parameters: { @@ -84161,18 +88525,19 @@ export interface operations { }; /** * Add teams to the Copilot subscription for an organization - * @description **Note**: This endpoint is in beta and is subject to change. + * @description > [!NOTE] + * > This endpoint is in public preview 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)". + * The organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see "[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization)." * - * Only organization owners can configure GitHub Copilot in their organization. + * Only organization owners can purchase Copilot seats for their organization members. The organization must have a Copilot Business or Copilot Enterprise subscription and a configured suggestion matching policy. + * For more information about setting up a Copilot subscription, see "[Subscribing to Copilot for your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/subscribing-to-copilot-for-your-organization)." + * For more information about setting a suggestion matching policy, see "[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching)." * - * 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)". + * The response contains the total number of new seats that were created and existing seats that were refreshed. * - * 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 either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. */ "copilot/add-copilot-seats-for-teams": { parameters: { @@ -84209,18 +88574,18 @@ export interface operations { }; /** * 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. + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. * - * 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)". + * Sets seats for all members of each team specified to "pending cancellation". + * This will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through another team. + * For more information about disabling access to Copilot, see "[Revoking access to Copilot for members of your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-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 cancel Copilot seats for their organization members. * - * Only organization owners can configure GitHub Copilot in their organization. + * The response contains the total number of seats set to "pending cancellation". * - * 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 either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. */ "copilot/cancel-copilot-seat-assignment-for-teams": { parameters: { @@ -84257,18 +88622,19 @@ export interface operations { }; /** * Add users to the Copilot subscription for an organization - * @description **Note**: This endpoint is in beta and is subject to change. + * @description > [!NOTE] + * > This endpoint is in public preview 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)". + * The organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see "[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization)." * - * Only organization owners can configure GitHub Copilot in their organization. + * Only organization owners can purchase Copilot seats for their organization members. The organization must have a Copilot Business or Copilot Enterprise subscription and a configured suggestion matching policy. + * For more information about setting up a Copilot subscription, see "[Subscribing to Copilot for your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/subscribing-to-copilot-for-your-organization)." + * For more information about setting a suggestion matching policy, see "[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching)." * - * 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)". + * The response contains the total number of new seats that were created and existing seats that were refreshed. * - * 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 either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. */ "copilot/add-copilot-seats-for-users": { parameters: { @@ -84305,18 +88671,18 @@ export interface operations { }; /** * Remove users from the Copilot subscription for an organization - * @description **Note**: This endpoint is in beta and is subject to change. + * @description > [!NOTE] + * > This endpoint is in public preview 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. + * Sets seats for all users specified to "pending cancellation". + * This will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through team membership. + * For more information about disabling access to Copilot, see "[Revoking access to Copilot for members of your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization)." * - * 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 cancel Copilot seats for their organization members. * - * 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)". + * The response contains the total number of seats set to "pending cancellation". * - * 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 either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. */ "copilot/cancel-copilot-seat-assignment-for-users": { parameters: { @@ -84351,22 +88717,66 @@ export interface operations { 500: components["responses"]["internal_error"]; }; }; + /** + * Get Copilot metrics for an organization + * @description Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions. + * + * > [!NOTE] + * > This endpoint will only return results for a given day if the organization contained **five or more members with active Copilot licenses** on that day, as evaluated at the end of that day. + * + * The response contains metrics for up to 28 days prior. 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. + * + * To access this endpoint, the Copilot Metrics API access policy must be enabled for the organization. + * Only organization owners and owners and billing managers of the parent enterprise can view Copilot metrics. + * + * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot`, `read:org`, or `read:enterprise` scopes to use this endpoint. + */ + "copilot/copilot-metrics-for-organization": { + parameters: { + query?: { + /** @description Show usage metrics since this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). Maximum value is 28 days ago. */ + 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; + 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; + }; + path: { + org: components["parameters"]["org"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["copilot-usage-metrics-day"][]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["usage_metrics_api_disabled"]; + 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. + * @description > [!NOTE] + * > This endpoint is in public preview 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, + * The response contains metrics for up to 28 days prior. 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. + * Organization owners, and owners and billing managers of the parent enterprise, 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 either the `manage_billing:copilot`, `read:org`, or `read:enterprise` scopes to use this endpoint. */ "copilot/usage-metrics-for-org": { parameters: { @@ -84786,7 +89196,11 @@ export interface operations { 403: components["responses"]["forbidden"]; }; }; - /** List public organization events */ + /** + * List public organization 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-public-org-events": { parameters: { query?: { @@ -84835,7 +89249,9 @@ export interface operations { }; /** * List organization webhooks - * @description You must be an organization owner to use this endpoint. + * @description List webhooks for an organization. + * + * The authenticated user 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. @@ -84953,7 +89369,9 @@ export interface operations { }; /** * Delete an organization webhook - * @description You must be an organization owner to use this endpoint. + * @description Delete a webhook for an organization. + * + * The authenticated user 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. @@ -85105,7 +89523,6 @@ export interface operations { query?: { per_page?: components["parameters"]["per-page"]; cursor?: components["parameters"]["cursor"]; - redelivery?: boolean; }; path: { org: components["parameters"]["org"]; @@ -85199,6 +89616,240 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; + /** + * Get route stats by actor + * @description Get API request count statistics for an actor broken down by route within a specified time frame. + */ + "api-insights/get-route-stats-by-actor": { + parameters: { + query: { + min_timestamp: components["parameters"]["api-insights-min-timestamp"]; + max_timestamp?: components["parameters"]["api-insights-max-timestamp"]; + page?: components["parameters"]["page"]; + per_page?: components["parameters"]["per-page"]; + direction?: components["parameters"]["direction"]; + sort?: components["parameters"]["api-insights-route-stats-sort"]; + api_route_substring?: components["parameters"]["api-insights-api-route-substring"]; + }; + path: { + org: components["parameters"]["org"]; + actor_type: components["parameters"]["api-insights-actor-type"]; + actor_id: components["parameters"]["api-insights-actor-id"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["api-insights-route-stats"]; + }; + }; + }; + }; + /** + * Get subject stats + * @description Get API request statistics for all subjects within an organization within a specified time frame. Subjects can be users or GitHub Apps. + */ + "api-insights/get-subject-stats": { + parameters: { + query: { + min_timestamp: components["parameters"]["api-insights-min-timestamp"]; + max_timestamp?: components["parameters"]["api-insights-max-timestamp"]; + page?: components["parameters"]["page"]; + per_page?: components["parameters"]["per-page"]; + direction?: components["parameters"]["direction"]; + sort?: components["parameters"]["api-insights-sort"]; + subject_name_substring?: components["parameters"]["api-insights-subject-name-substring"]; + }; + path: { + org: components["parameters"]["org"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["api-insights-subject-stats"]; + }; + }; + }; + }; + /** + * Get summary stats + * @description Get overall statistics of API requests made within an organization by all users and apps within a specified time frame. + */ + "api-insights/get-summary-stats": { + parameters: { + query: { + min_timestamp: components["parameters"]["api-insights-min-timestamp"]; + max_timestamp?: components["parameters"]["api-insights-max-timestamp"]; + }; + path: { + org: components["parameters"]["org"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["api-insights-summary-stats"]; + }; + }; + }; + }; + /** + * Get summary stats by user + * @description Get overall statistics of API requests within the organization for a user. + */ + "api-insights/get-summary-stats-by-user": { + parameters: { + query: { + min_timestamp: components["parameters"]["api-insights-min-timestamp"]; + max_timestamp?: components["parameters"]["api-insights-max-timestamp"]; + }; + path: { + org: components["parameters"]["org"]; + user_id: components["parameters"]["api-insights-user-id"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["api-insights-summary-stats"]; + }; + }; + }; + }; + /** + * Get summary stats by actor + * @description Get overall statistics of API requests within the organization made by a specific actor. Actors can be GitHub App installations, OAuth apps or other tokens on behalf of a user. + */ + "api-insights/get-summary-stats-by-actor": { + parameters: { + query: { + min_timestamp: components["parameters"]["api-insights-min-timestamp"]; + max_timestamp?: components["parameters"]["api-insights-max-timestamp"]; + }; + path: { + org: components["parameters"]["org"]; + actor_type: components["parameters"]["api-insights-actor-type"]; + actor_id: components["parameters"]["api-insights-actor-id"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["api-insights-summary-stats"]; + }; + }; + }; + }; + /** + * Get time stats + * @description Get the number of API requests and rate-limited requests made within an organization over a specified time period. + */ + "api-insights/get-time-stats": { + parameters: { + query: { + min_timestamp: components["parameters"]["api-insights-min-timestamp"]; + max_timestamp?: components["parameters"]["api-insights-max-timestamp"]; + timestamp_increment: components["parameters"]["api-insights-timestamp-increment"]; + }; + path: { + org: components["parameters"]["org"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["api-insights-time-stats"]; + }; + }; + }; + }; + /** + * Get time stats by user + * @description Get the number of API requests and rate-limited requests made within an organization by a specific user over a specified time period. + */ + "api-insights/get-time-stats-by-user": { + parameters: { + query: { + min_timestamp: components["parameters"]["api-insights-min-timestamp"]; + max_timestamp?: components["parameters"]["api-insights-max-timestamp"]; + timestamp_increment: components["parameters"]["api-insights-timestamp-increment"]; + }; + path: { + org: components["parameters"]["org"]; + user_id: components["parameters"]["api-insights-user-id"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["api-insights-time-stats"]; + }; + }; + }; + }; + /** + * Get time stats by actor + * @description Get the number of API requests and rate-limited requests made within an organization by a specific actor within a specified time period. + */ + "api-insights/get-time-stats-by-actor": { + parameters: { + query: { + min_timestamp: components["parameters"]["api-insights-min-timestamp"]; + max_timestamp?: components["parameters"]["api-insights-max-timestamp"]; + timestamp_increment: components["parameters"]["api-insights-timestamp-increment"]; + }; + path: { + org: components["parameters"]["org"]; + actor_type: components["parameters"]["api-insights-actor-type"]; + actor_id: components["parameters"]["api-insights-actor-id"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["api-insights-time-stats"]; + }; + }; + }; + }; + /** + * Get user stats + * @description Get API usage statistics within an organization for a user broken down by the type of access. + */ + "api-insights/get-user-stats": { + parameters: { + query: { + min_timestamp: components["parameters"]["api-insights-min-timestamp"]; + max_timestamp?: components["parameters"]["api-insights-max-timestamp"]; + page?: components["parameters"]["page"]; + per_page?: components["parameters"]["per-page"]; + direction?: components["parameters"]["direction"]; + sort?: components["parameters"]["api-insights-sort"]; + actor_name_substring?: components["parameters"]["api-insights-actor-name-substring"]; + }; + path: { + org: components["parameters"]["org"]; + user_id: components["parameters"]["api-insights-user-id"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["api-insights-user-stats"]; + }; + }; + }; + }; /** * Get an organization installation for the authenticated app * @description Enables an authenticated GitHub App to find the organization's installation information. @@ -85319,7 +89970,10 @@ export interface operations { }; /** * 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`. + * @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: { @@ -85357,7 +90011,7 @@ export interface operations { * 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)" + * 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/using-the-rest-api/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": { @@ -85453,10 +90107,8 @@ 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/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)." * @@ -85670,13 +90322,17 @@ export interface operations { }; /** * Get Copilot seat assignment details for a user - * @description **Note**: This endpoint is in beta and is subject to change. + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. + * + * Gets the GitHub Copilot seat 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. + * The seat object contains information about the user's most recent Copilot activity. Users must have telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`. + * For more information about activity data, see "[Reviewing user activity data for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-user-activity-data-for-copilot-in-your-organization)." * - * Organization owners can view GitHub Copilot seat assignment details for members in their organization. + * Only organization owners can view Copilot seat assignment details for members of 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 either the `manage_billing:copilot` or `read:org` scopes to use this endpoint. */ "copilot/get-copilot-seat-details-for-user": { parameters: { @@ -85734,7 +90390,7 @@ export interface operations { * * **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, organization owners are limited to creating 50 organization invitations for an organization within a 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: { @@ -86014,39 +90670,9 @@ 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: { - path: { - org: components["parameters"]["org"]; - }; - }; - responses: { - /** @description Response */ - 200: { - content: { - "application/json": components["schemas"]["organization-fine-grained-permission"][]; - }; - }; - 404: components["responses"]["not_found"]; - 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)." + * @description Lists the organization roles available in this organization. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." * * To use this endpoint, the authenticated user must be one of: * @@ -86077,50 +90703,9 @@ 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: { - path: { - org: components["parameters"]["org"]; - }; - }; - requestBody: { - content: { - "application/json": { - /** @description The name of the custom role. */ - name: string; - /** @description A short description about the intended usage of this role or what permissions it grants. */ - description?: string; - /** @description A list of additional permissions included in this role. */ - permissions: string[]; - }; - }; - }; - responses: { - /** @description Response */ - 201: { - content: { - "application/json": components["schemas"]["organization-role"]; - }; - }; - 404: components["responses"]["not_found"]; - 409: components["responses"]["conflict"]; - 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)." + * @description Removes all assigned organization roles from a team. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." * * The authenticated user must be an administrator for the organization to use this endpoint. * @@ -86142,7 +90727,7 @@ export interface operations { }; /** * 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)." + * @description Assigns an organization role to a team in an organization. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." * * The authenticated user must be an administrator for the organization to use this endpoint. * @@ -86173,7 +90758,7 @@ export interface operations { }; /** * 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)." + * @description Removes an organization role from a team. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." * * The authenticated user must be an administrator for the organization to use this endpoint. * @@ -86196,7 +90781,7 @@ export interface operations { }; /** * 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)." + * @description Revokes all assigned organization roles from a user. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." * * The authenticated user must be an administrator for the organization to use this endpoint. * @@ -86218,7 +90803,7 @@ export interface operations { }; /** * 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)." + * @description Assigns an organization role to a member of an organization. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." * * The authenticated user must be an administrator for the organization to use this endpoint. * @@ -86249,7 +90834,7 @@ export interface operations { }; /** * 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)." + * @description Remove an organization role from a user. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." * * The authenticated user must be an administrator for the organization to use this endpoint. * @@ -86272,7 +90857,7 @@ export interface operations { }; /** * 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)." + * @description Gets an organization role that is available to this organization. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." * * To use this endpoint, the authenticated user must be one of: * @@ -86299,77 +90884,9 @@ 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: { - path: { - org: components["parameters"]["org"]; - role_id: components["parameters"]["role-id"]; - }; - }; - 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. - */ - "orgs/patch-custom-organization-role": { - parameters: { - path: { - org: components["parameters"]["org"]; - role_id: components["parameters"]["role-id"]; - }; - }; - requestBody: { - content: { - "application/json": { - /** @description The name of the custom role. */ - name?: string; - /** @description A short description about the intended usage of this role or what permissions it grants. */ - description?: string; - /** @description A list of additional permissions included in this role. */ - permissions?: string[]; - }; - }; - }; - responses: { - /** @description Response */ - 200: { - content: { - "application/json": components["schemas"]["organization-role"]; - }; - }; - 404: components["responses"]["not_found"]; - 409: components["responses"]["conflict"]; - 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)." + * @description Lists the teams that are assigned to an organization role. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." * * To use this endpoint, you must be an administrator for the organization. * @@ -86393,7 +90910,7 @@ export interface operations { Link: components["headers"]["link"]; }; content: { - "application/json": components["schemas"]["team"][]; + "application/json": components["schemas"]["team-role-assignment"][]; }; }; /** @description Response if the organization or role does not exist. */ @@ -86408,7 +90925,7 @@ export interface operations { }; /** * 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)." + * @description Lists organization members that are assigned to an organization role. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." * * To use this endpoint, you must be an administrator for the organization. * @@ -86432,7 +90949,7 @@ export interface operations { Link: components["headers"]["link"]; }; content: { - "application/json": components["schemas"]["simple-user"][]; + "application/json": components["schemas"]["user-role-assignment"][]; }; }; /** @description Response if the organization or role does not exist. */ @@ -86544,7 +91061,7 @@ 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)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, 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: { @@ -86583,7 +91100,7 @@ export interface operations { * 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. For more information, 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: { @@ -86608,7 +91125,7 @@ export interface operations { * * 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. For more information, 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: { @@ -86638,7 +91155,7 @@ export interface operations { * * 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. For more information, 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: { @@ -86666,7 +91183,7 @@ export interface operations { * 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 `read:packages` scope to use this endpoint. For more information, 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: { @@ -86698,7 +91215,7 @@ export interface operations { * 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. For more information, 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: { @@ -86724,7 +91241,7 @@ export interface operations { * * 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. For more information, 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: { @@ -86755,7 +91272,7 @@ export interface operations { * * 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. For more information, 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: { @@ -87055,6 +91572,232 @@ export interface operations { 500: components["responses"]["internal_error"]; }; }; + /** + * List private registries for an organization + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. + * + * Lists all private registry configurations 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. + */ + "private-registries/list-org-private-registries": { + parameters: { + query?: { + per_page?: components["parameters"]["per-page"]; + page?: components["parameters"]["page"]; + }; + path: { + org: components["parameters"]["org"]; + }; + }; + responses: { + /** @description Response */ + 200: { + headers: { + Link: components["headers"]["link"]; + }; + content: { + "application/json": { + total_count: number; + configurations: components["schemas"]["org-private-registry-configuration"][]; + }; + }; + }; + 400: components["responses"]["bad_request"]; + 404: components["responses"]["not_found"]; + }; + }; + /** + * Create a private registry for an organization + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. + * + * Creates a private registry configuration with an encrypted value for an organization. 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. + */ + "private-registries/create-org-private-registry": { + parameters: { + path: { + org: components["parameters"]["org"]; + }; + }; + requestBody: { + content: { + "application/json": { + /** + * @description The registry type. + * @enum {string} + */ + registry_type: "maven_repository"; + /** @description The username to use when authenticating with the private registry. This field should be omitted if the private registry does not require a username for authentication. */ + username?: string | null; + /** @description The value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get private registries public key for an organization](https://docs.github.com/rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization) endpoint. */ + encrypted_value: string; + /** @description The ID of the key you used to encrypt the secret. */ + key_id: string; + /** + * @description Which type of organization repositories have access to the private registry. `selected` means only the repositories specified by `selected_repository_ids` can access the private registry. + * @enum {string} + */ + visibility: "all" | "private" | "selected"; + /** @description An array of repository IDs that can access the organization private registry. You can only provide a list of repository IDs when `visibility` is set to `selected`. You can manage the list of selected repositories using the [Update a private registry for an organization](https://docs.github.com/rest/private-registries/organization-configurations#update-a-private-registry-for-an-organization) endpoint. This field should be omitted if `visibility` is set to `all` or `private`. */ + selected_repository_ids?: number[]; + }; + }; + }; + responses: { + /** @description The organization private registry configuration */ + 201: { + content: { + "application/json": components["schemas"]["org-private-registry-configuration-with-selected-repositories"]; + }; + }; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + }; + }; + /** + * Get private registries public key for an organization + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. + * + * Gets the org public key, which is needed to encrypt private registry secrets. You need to encrypt a secret before you can create or update secrets. + * + * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + "private-registries/get-org-public-key": { + parameters: { + path: { + org: components["parameters"]["org"]; + }; + }; + responses: { + /** @description Response */ + 200: { + headers: { + Link: components["headers"]["link"]; + }; + content: { + "application/json": { + /** + * @description The identifier for the key. + * @example 012345678912345678 + */ + key_id: string; + /** + * @description The Base64 encoded public key. + * @example 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 + */ + key: string; + }; + }; + }; + 404: components["responses"]["not_found"]; + }; + }; + /** + * Get a private registry for an organization + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. + * + * Get the configuration of a single private registry defined for an organization, omitting its encrypted value. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + "private-registries/get-org-private-registry": { + parameters: { + path: { + org: components["parameters"]["org"]; + secret_name: components["parameters"]["secret-name"]; + }; + }; + responses: { + /** @description The specified private registry configuration for the organization */ + 200: { + content: { + "application/json": components["schemas"]["org-private-registry-configuration"]; + }; + }; + 404: components["responses"]["not_found"]; + }; + }; + /** + * Delete a private registry for an organization + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. + * + * Delete a private registry configuration at the organization-level. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + "private-registries/delete-org-private-registry": { + parameters: { + path: { + org: components["parameters"]["org"]; + secret_name: components["parameters"]["secret-name"]; + }; + }; + responses: { + /** @description Response */ + 204: { + content: never; + }; + 400: components["responses"]["bad_request"]; + 404: components["responses"]["not_found"]; + }; + }; + /** + * Update a private registry for an organization + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. + * + * Updates a private registry configuration with an encrypted value for an organization. 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. + */ + "private-registries/update-org-private-registry": { + parameters: { + path: { + org: components["parameters"]["org"]; + secret_name: components["parameters"]["secret-name"]; + }; + }; + requestBody: { + content: { + "application/json": { + /** + * @description The registry type. + * @enum {string} + */ + registry_type?: "maven_repository"; + /** @description The username to use when authenticating with the private registry. This field should be omitted if the private registry does not require a username for authentication. */ + username?: string | null; + /** @description The value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get private registries public key for an organization](https://docs.github.com/rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization) endpoint. */ + encrypted_value?: string; + /** @description The ID of the key you used to encrypt the secret. */ + key_id?: string; + /** + * @description Which type of organization repositories have access to the private registry. `selected` means only the repositories specified by `selected_repository_ids` can access the private registry. + * @enum {string} + */ + visibility?: "all" | "private" | "selected"; + /** @description An array of repository IDs that can access the organization private registry. You can only provide a list of repository IDs when `visibility` is set to `selected`. This field should be omitted if `visibility` is set to `all` or `private`. */ + selected_repository_ids?: number[]; + }; + }; + }; + responses: { + /** @description Response */ + 204: { + content: never; + }; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + }; + }; /** * 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. @@ -87133,7 +91876,7 @@ export interface operations { /** @description Response */ 200: { content: { - "application/json": components["schemas"]["org-custom-property"][]; + "application/json": components["schemas"]["custom-property"][]; }; }; 403: components["responses"]["forbidden"]; @@ -87158,7 +91901,7 @@ export interface operations { content: { "application/json": { /** @description The array of custom properties to create or update. */ - properties: components["schemas"]["org-custom-property"][]; + properties: components["schemas"]["custom-property"][]; }; }; }; @@ -87166,7 +91909,7 @@ export interface operations { /** @description Response */ 200: { content: { - "application/json": components["schemas"]["org-custom-property"][]; + "application/json": components["schemas"]["custom-property"][]; }; }; 403: components["responses"]["forbidden"]; @@ -87189,7 +91932,7 @@ export interface operations { /** @description Response */ 200: { content: { - "application/json": components["schemas"]["org-custom-property"]; + "application/json": components["schemas"]["custom-property"]; }; }; 403: components["responses"]["forbidden"]; @@ -87213,32 +91956,14 @@ export interface operations { }; requestBody: { content: { - "application/json": { - /** - * @description The type of the value for the property - * @example single_select - * @enum {string} - */ - value_type: "string" | "single_select"; - /** @description Whether the property is required. */ - required?: boolean; - /** @description Default value of the property */ - 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. - */ - allowed_values?: string[] | null; - }; + "application/json": components["schemas"]["custom-property-set-payload"]; }; }; responses: { /** @description Response */ 200: { content: { - "application/json": components["schemas"]["org-custom-property"]; + "application/json": components["schemas"]["custom-property"]; }; }; 403: components["responses"]["forbidden"]; @@ -87427,7 +92152,8 @@ export interface operations { * 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)." */ "repos/list-for-org": { parameters: { @@ -87552,12 +92278,14 @@ export interface operations { delete_branch_on_merge?: boolean; /** * @deprecated - * @description Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; /** - * @description The default value for a squash merge commit title: + * @description Required when using `squash_merge_commit_message`. + * + * The default value for a squash merge commit title: * * - `PR_TITLE` - default to the pull request's title. * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). @@ -87574,7 +92302,9 @@ export interface operations { */ squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** - * @description The default value for a merge commit title. + * @description Required when using `merge_commit_message`. + * + * The default value for a merge commit title. * * - `PR_TITLE` - default to the pull request's title. * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). @@ -87621,6 +92351,7 @@ export interface operations { query?: { per_page?: components["parameters"]["per-page"]; page?: components["parameters"]["page"]; + targets?: components["parameters"]["ruleset-targets"]; }; path: { org: components["parameters"]["org"]; @@ -87655,11 +92386,10 @@ export interface operations { name: string; /** * @description The target of the ruleset - * - * **Note**: The `push` target is in beta and is subject to change. + * @default branch * @enum {string} */ - target?: "branch" | "tag" | "push"; + target?: "branch" | "tag" | "push" | "repository"; enforcement: components["schemas"]["repository-rule-enforcement"]; /** @description The actors that can bypass the rules in this ruleset */ bypass_actors?: components["schemas"]["repository-ruleset-bypass-actor"][]; @@ -87688,6 +92418,7 @@ export interface operations { "repos/get-org-rule-suites": { parameters: { query?: { + ref?: components["parameters"]["ref-in-query"]; repository_name?: components["parameters"]["repository-name-in-query"]; time_period?: components["parameters"]["time-period"]; actor_name?: components["parameters"]["actor-name-in-query"]; @@ -87736,6 +92467,9 @@ export interface operations { /** * Get an organization repository ruleset * @description Get a repository ruleset for an organization. + * + * **Note:** To prevent leaking sensitive information, the `bypass_actors` property is only returned if the user + * making the API request has write access to the ruleset. */ "repos/get-org-ruleset": { parameters: { @@ -87776,11 +92510,9 @@ export interface operations { name?: string; /** * @description The target of the ruleset - * - * **Note**: The `push` target is in beta and is subject to change. * @enum {string} */ - target?: "branch" | "tag" | "push"; + target?: "branch" | "tag" | "push" | "repository"; enforcement?: components["schemas"]["repository-rule-enforcement"]; /** @description The actors that can bypass the rules in this ruleset */ bypass_actors?: components["schemas"]["repository-ruleset-bypass-actor"][]; @@ -87843,6 +92575,8 @@ export interface operations { before?: components["parameters"]["secret-scanning-pagination-before-org-repo"]; after?: components["parameters"]["secret-scanning-pagination-after-org-repo"]; validity?: components["parameters"]["secret-scanning-alert-validity"]; + is_publicly_leaked?: components["parameters"]["secret-scanning-alert-publicly-leaked"]; + is_multi_repo?: components["parameters"]["secret-scanning-alert-multi-repo"]; }; path: { org: components["parameters"]["org"]; @@ -87900,11 +92634,9 @@ export interface operations { }; /** * 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. + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** This operation is closing down and will be removed starting January 1, 2026. Please use the "[Organization Roles](https://docs.github.com/rest/orgs/organization-roles)" endpoints instead. */ "orgs/list-security-manager-teams": { parameters: { @@ -87923,11 +92655,9 @@ export interface operations { }; /** * 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. + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** This operation is closing down and will be removed starting January 1, 2026. Please use the "[Organization Roles](https://docs.github.com/rest/orgs/organization-roles)" endpoints instead. */ "orgs/add-security-manager-team": { parameters: { @@ -87941,19 +92671,13 @@ export interface operations { 204: { content: never; }; - /** @description The organization has reached the maximum number of security manager teams. */ - 409: { - 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. + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** This operation is closing down and will be removed starting January 1, 2026. Please use the "[Organization Roles](https://docs.github.com/rest/orgs/organization-roles)" endpoints instead. */ "orgs/remove-security-manager-team": { parameters: { @@ -88038,24 +92762,70 @@ export interface operations { }; }; }; + /** + * Get Copilot metrics for a team + * @description Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions. + * + * > [!NOTE] + * > This endpoint will only return results for a given day if the team had **five or more members with active Copilot licenses** on that day, as evaluated at the end of that day. + * + * The response contains metrics for up to 28 days prior. 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. + * + * To access this endpoint, the Copilot Metrics API access policy must be enabled for the organization containing the team within GitHub settings. + * Only organization owners for the organization that contains this team and owners and billing managers of the parent enterprise can view Copilot metrics for a team. + * + * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot`, `read:org`, or `read:enterprise` scopes to use this endpoint. + */ + "copilot/copilot-metrics-for-team": { + parameters: { + query?: { + /** @description Show usage metrics since this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). Maximum value is 28 days ago. */ + 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; + 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; + }; + path: { + org: components["parameters"]["org"]; + team_slug: components["parameters"]["team-slug"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["copilot-usage-metrics-day"][]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["usage_metrics_api_disabled"]; + 500: components["responses"]["internal_error"]; + }; + }; /** * Get a summary of Copilot usage for a team - * @description **Note**: This endpoint is in beta and is subject to change. + * @description > [!NOTE] + * > This endpoint is in public preview 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, + * The response contains metrics for up to 28 days prior. 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 with active Copilot licenses, as evaluated at the end of 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. + * Organization owners for the organization that contains this team, and owners and billing managers of the parent enterprise 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 either the `manage_billing:copilot`, `read:org`, or `read:enterprise` scopes to use this endpoint. */ "copilot/usage-metrics-for-team": { parameters: { @@ -88159,7 +92929,7 @@ export interface operations { | "notifications_enabled" | "notifications_disabled"; /** - * @description **Deprecated**. The permission that new repositories will be added to the team with when none is specified. + * @description **Closing down notice**. The permission that new repositories will be added to the team with when none is specified. * @default pull * @enum {string} */ @@ -88184,7 +92954,8 @@ export interface operations { * 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}`. */ "teams/get-by-name": { parameters: { @@ -88209,7 +92980,8 @@ export interface operations { * * 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}`. */ "teams/delete-in-org": { parameters: { @@ -88229,7 +93001,8 @@ export interface operations { * 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}`. */ "teams/update-in-org": { parameters: { @@ -88265,7 +93038,7 @@ export interface operations { | "notifications_enabled" | "notifications_disabled"; /** - * @description **Deprecated**. The permission that new repositories will be added to the team with when none is specified. + * @description **Closing down notice**. The permission that new repositories will be added to the team with when none is specified. * @default pull * @enum {string} */ @@ -88297,7 +93070,8 @@ export interface operations { * 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. */ @@ -88331,9 +93105,10 @@ 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)." + * 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/using-the-rest-api/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. */ @@ -88372,7 +93147,8 @@ export interface operations { * 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. */ @@ -88397,7 +93173,8 @@ export interface operations { * 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. */ @@ -88420,7 +93197,8 @@ export interface operations { * 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. */ @@ -88455,7 +93233,8 @@ export interface operations { * 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. */ @@ -88488,9 +93267,10 @@ 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)." + * 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/using-the-rest-api/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. */ @@ -88523,7 +93303,8 @@ export interface operations { * 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. */ @@ -88549,7 +93330,8 @@ export interface operations { * 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. */ @@ -88573,7 +93355,8 @@ export interface operations { * 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. */ @@ -88607,7 +93390,8 @@ export interface operations { * 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. */ @@ -88652,7 +93436,8 @@ export interface operations { * * 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. */ @@ -88701,7 +93486,8 @@ export interface operations { }; /** * 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`. + * @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). * @@ -88728,7 +93514,8 @@ export interface operations { * 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. */ @@ -88772,7 +93559,8 @@ export interface operations { * * 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. */ @@ -88820,7 +93608,8 @@ export interface operations { }; /** * 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`. + * @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). * @@ -88846,7 +93635,8 @@ export interface operations { * 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`. */ "teams/list-pending-invitations-in-org": { parameters: { @@ -88908,10 +93698,11 @@ export interface operations { * * 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). */ @@ -88942,13 +93733,15 @@ export interface operations { * * 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. * * 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}`. */ "teams/add-or-update-membership-for-user-in-org": { parameters: { @@ -88993,9 +93786,11 @@ export interface operations { * * 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}`. */ "teams/remove-membership-for-user-in-org": { parameters: { @@ -89020,7 +93815,8 @@ export interface operations { * 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`. */ "teams/list-projects-in-org": { parameters: { @@ -89049,7 +93845,8 @@ 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}`. + * > [!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: { @@ -89076,7 +93873,8 @@ export interface operations { * 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}`. */ "teams/add-or-update-project-permissions-in-org": { parameters: { @@ -89117,7 +93915,8 @@ 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}`. + * > [!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: { @@ -89138,7 +93937,8 @@ export interface operations { * 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`. */ "teams/list-repos-in-org": { parameters: { @@ -89167,13 +93967,14 @@ 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. + * 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/using-the-rest-api/getting-started-with-the-rest-api#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}`. + * > [!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: { @@ -89205,7 +94006,8 @@ export interface operations { * 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)". */ @@ -89221,10 +94023,7 @@ export interface operations { requestBody?: { content: { "application/json": { - /** - * @description The permission to grant the team on this repository. We accept the following permissions to be set: `pull`, `triage`, `push`, `maintain`, `admin` and you can also specify a custom repository role name, if the owning organization has defined any. If no permission is specified, the team's `permission` attribute will be used to determine what permission to grant the team on this repository. - * @default push - */ + /** @description The permission to grant the team on this repository. We accept the following permissions to be set: `pull`, `triage`, `push`, `maintain`, `admin` and you can also specify a custom repository role name, if the owning organization has defined any. If no permission is specified, the team's `permission` attribute will be used to determine what permission to grant the team on this repository. */ permission?: string; }; }; @@ -89240,7 +94039,8 @@ export interface operations { * 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}`. */ "teams/remove-repo-in-org": { parameters: { @@ -89262,7 +94062,8 @@ export interface operations { * 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`. */ "teams/list-child-in-org": { parameters: { @@ -89289,11 +94090,15 @@ 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)." + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** The ability to enable or disable a security feature for all eligible repositories in an organization is closing down. Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. For more information, see the [changelog](https://github.blog/changelog/2024-07-22-deprecation-of-api-endpoint-to-enable-or-disable-a-security-feature-for-an-organization/). + * + * 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. + * OAuth app tokens and personal access tokens (classic) need the `admin:org`, `write:org`, or `repo` scopes to use this endpoint. */ "orgs/enable-or-disable-security-product-on-all-org-repos": { parameters: { @@ -89983,7 +94788,8 @@ export interface operations { }; /** * Get rate limit status for the authenticated user - * @description **Note:** Accessing this endpoint does not count against your REST API rate limit. + * @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. @@ -89994,9 +94800,10 @@ export interface operations { * * 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)." + * * 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/about-the-rest-api/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 closing down. 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": { responses: { @@ -90019,7 +94826,8 @@ export interface operations { * 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)." */ "repos/get": { parameters: { @@ -90131,6 +94939,16 @@ export interface operations { /** @description Can be `enabled` or `disabled`. */ status?: string; }; + /** @description Use the `status` property to enable or disable secret scanning AI detection for this repository. For more information, see "[Responsible detection of generic secrets with AI](https://docs.github.com/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/generic-secret-detection/responsible-ai-generic-secrets)." */ + secret_scanning_ai_detection?: { + /** @description Can be `enabled` or `disabled`. */ + status?: string; + }; + /** @description Use the `status` property to enable or disable secret scanning non-provider patterns for this repository. For more information, see "[Supported secret scanning patterns](/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)." */ + secret_scanning_non_provider_patterns?: { + /** @description Can be `enabled` or `disabled`. */ + status?: string; + }; } | null; /** * @description Either `true` to enable issues for this repository or `false` to disable them. @@ -90186,12 +95004,14 @@ export interface operations { allow_update_branch?: boolean; /** * @deprecated - * @description Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; /** - * @description The default value for a squash merge commit title: + * @description Required when using `squash_merge_commit_message`. + * + * The default value for a squash merge commit title: * * - `PR_TITLE` - default to the pull request's title. * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). @@ -90208,7 +95028,9 @@ export interface operations { */ squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** - * @description The default value for a merge commit title. + * @description Required when using `merge_commit_message`. + * + * The default value for a merge commit title. * * - `PR_TITLE` - default to the pull request's title. * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). @@ -91231,7 +96053,7 @@ export interface operations { * * 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 endpoint 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: { @@ -91526,8 +96348,8 @@ export interface operations { * 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. */ @@ -92276,6 +97098,8 @@ export interface operations { * 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 endpoint 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": { parameters: { @@ -92455,6 +97279,103 @@ export interface operations { }; }; }; + /** + * Create an attestation + * @description Store an artifact attestation and associate it with a repository. + * + * The authenticated user must have write permission to the repository and, if using a fine-grained access token, the `attestations:write` permission is required. + * + * Artifact attestations are meant to be created using the [attest action](https://github.com/actions/attest). For more information, see our guide on [using artifact attestations to establish a build's provenance](https://docs.github.com/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds). + */ + "repos/create-attestation": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + requestBody: { + content: { + "application/json": { + /** + * @description The attestation's Sigstore Bundle. + * Refer to the [Sigstore Bundle Specification](https://github.com/sigstore/protobuf-specs/blob/main/protos/sigstore_bundle.proto) for more information. + */ + bundle: { + mediaType?: string; + verificationMaterial?: { + [key: string]: unknown; + }; + dsseEnvelope?: { + [key: string]: unknown; + }; + }; + }; + }; + }; + responses: { + /** @description response */ + 201: { + content: { + "application/json": { + /** @description The ID of the attestation. */ + id?: number; + }; + }; + }; + 403: components["responses"]["forbidden"]; + 422: components["responses"]["validation_failed"]; + }; + }; + /** + * List attestations + * @description List a collection of artifact attestations with a given subject digest that are associated with a repository. + * + * The authenticated user making the request must have read access to the repository. In addition, when using a fine-grained access token the `attestations:read` permission is required. + * + * **Please note:** in order to offer meaningful security benefits, an attestation's signature and timestamps **must** be cryptographically verified, and the identity of the attestation signer **must** be validated. Attestations can be verified using the [GitHub CLI `attestation verify` command](https://cli.github.com/manual/gh_attestation_verify). For more information, see [our guide on how to use artifact attestations to establish a build's provenance](https://docs.github.com/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds). + */ + "repos/list-attestations": { + parameters: { + query?: { + per_page?: components["parameters"]["per-page"]; + before?: components["parameters"]["pagination-before"]; + after?: components["parameters"]["pagination-after"]; + }; + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** @description The parameter should be set to the attestation's subject's SHA256 digest, in the form `sha256:HEX_DIGEST`. */ + subject_digest: string; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": { + attestations?: { + /** + * @description The attestation's Sigstore Bundle. + * Refer to the [Sigstore Bundle Specification](https://github.com/sigstore/protobuf-specs/blob/main/protos/sigstore_bundle.proto) for more information. + */ + bundle?: { + mediaType?: string; + verificationMaterial?: { + [key: string]: unknown; + }; + dsseEnvelope?: { + [key: string]: unknown; + }; + }; + repository_id?: number; + bundle_url?: string; + }[]; + }; + }; + }; + }; + }; /** * Get all autolinks of a repository * @description Gets all autolinks that are configured for a repository. @@ -92575,13 +97496,13 @@ export interface operations { }; }; responses: { - /** @description Response if dependabot is enabled */ + /** @description Response if Dependabot is enabled */ 200: { content: { "application/json": components["schemas"]["check-automated-security-fixes"]; }; }; - /** @description Not Found if dependabot is not enabled for the repository */ + /** @description Not Found if Dependabot is not enabled for the repository */ 404: { content: never; }; @@ -92627,7 +97548,7 @@ export interface operations { "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. */ + /** @description Setting to `true` returns only branches protected by branch protections or rulesets. When set to `false`, only unprotected branches are returned. Omitting this parameter returns all branches. */ protected?: boolean; per_page?: components["parameters"]["per-page"]; page?: components["parameters"]["page"]; @@ -92698,9 +97619,11 @@ export interface operations { * * 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. */ "repos/update-branch-protection": { parameters: { @@ -92719,7 +97642,7 @@ export interface operations { strict: boolean; /** * @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. + * @description **Closing down notice**: 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. */ @@ -92941,7 +97864,8 @@ export interface operations { * * 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. */ "repos/update-pull-request-review-protection": { parameters: { @@ -93002,7 +97926,8 @@ export interface operations { * * 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. */ "repos/get-commit-signature-protection": { parameters: { @@ -93130,7 +98055,7 @@ export interface operations { strict?: boolean; /** * @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. + * @description **Closing down notice**: 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. */ @@ -93276,7 +98201,8 @@ export interface operations { * * 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. */ "repos/get-access-restrictions": { parameters: { @@ -93355,7 +98281,7 @@ export interface operations { branch: components["parameters"]["branch"]; }; }; - requestBody?: { + requestBody: { content: { "application/json": { /** @description The GitHub Apps that have push access to this branch. Use the slugified version of the app name. **Note**: The list of users, apps, and teams in total is limited to 100 items. */ @@ -93387,7 +98313,7 @@ export interface operations { branch: components["parameters"]["branch"]; }; }; - requestBody?: { + requestBody: { content: { "application/json": { /** @description The GitHub Apps that have push access to this branch. Use the slugified version of the app name. **Note**: The list of users, apps, and teams in total is limited to 100 items. */ @@ -93419,7 +98345,7 @@ export interface operations { branch: components["parameters"]["branch"]; }; }; - requestBody?: { + requestBody: { content: { "application/json": { /** @description The GitHub Apps that have push access to this branch. Use the slugified version of the app name. **Note**: The list of users, apps, and teams in total is limited to 100 items. */ @@ -93599,7 +98525,7 @@ export interface operations { branch: components["parameters"]["branch"]; }; }; - requestBody?: { + requestBody: { content: { "application/json": { /** @description The username for users */ @@ -93635,7 +98561,7 @@ export interface operations { branch: components["parameters"]["branch"]; }; }; - requestBody?: { + requestBody: { content: { "application/json": { /** @description The username for users */ @@ -93671,7 +98597,7 @@ export interface operations { branch: components["parameters"]["branch"]; }; }; - requestBody?: { + requestBody: { content: { "application/json": { /** @description The username for users */ @@ -93693,7 +98619,8 @@ export interface operations { * 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. * @@ -93850,7 +98777,8 @@ export interface operations { * 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. */ @@ -93875,7 +98803,8 @@ export interface operations { * 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. */ @@ -94077,7 +99006,8 @@ export interface operations { * 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. */ @@ -94152,7 +99082,8 @@ export interface operations { * 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. */ @@ -94177,7 +99108,8 @@ export interface operations { * 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. */ @@ -94341,6 +99273,112 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; + /** + * Get the status of an autofix for a code scanning alert + * @description Gets the status and description of an autofix for a 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-autofix": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + alert_number: components["parameters"]["alert-number"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["code-scanning-autofix"]; + }; + }; + 400: components["responses"]["code_scanning_bad_request"]; + 403: components["responses"]["code_scanning_forbidden_read"]; + 404: components["responses"]["not_found"]; + 503: components["responses"]["service_unavailable"]; + }; + }; + /** + * Create an autofix for a code scanning alert + * @description Creates an autofix for a code scanning alert. + * + * If a new autofix is to be created as a result of this request or is currently being generated, then this endpoint will return a 202 Accepted response. + * + * If an autofix already exists for a given alert, then this endpoint will return a 200 OK response. + * + * 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/create-autofix": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + alert_number: components["parameters"]["alert-number"]; + }; + }; + responses: { + /** @description OK */ + 200: { + content: { + "application/json": components["schemas"]["code-scanning-autofix"]; + }; + }; + /** @description Accepted */ + 202: { + content: { + "application/json": components["schemas"]["code-scanning-autofix"]; + }; + }; + 400: components["responses"]["code_scanning_bad_request"]; + 403: components["responses"]["code_scanning_autofix_create_forbidden"]; + 404: components["responses"]["not_found"]; + /** @description Unprocessable Entity */ + 422: { + content: never; + }; + 503: components["responses"]["service_unavailable"]; + }; + }; + /** + * Commit an autofix for a code scanning alert + * @description Commits an autofix for a code scanning alert. + * + * If an autofix is commited as a result of this request, then this endpoint will return a 201 Created response. + * + * 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/commit-autofix": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + alert_number: components["parameters"]["alert-number"]; + }; + }; + requestBody?: { + content: { + "application/json": components["schemas"]["code-scanning-autofix-commits"]; + }; + }; + responses: { + /** @description Created */ + 201: { + content: { + "application/json": components["schemas"]["code-scanning-autofix-commits-response"]; + }; + }; + 400: components["responses"]["code_scanning_bad_request"]; + 403: components["responses"]["code_scanning_forbidden_write"]; + 404: components["responses"]["not_found"]; + /** @description Unprocessable Entity */ + 422: { + content: never; + }; + 503: components["responses"]["service_unavailable"]; + }; + }; /** * List instances of a code scanning alert * @description Lists all instances of the specified code scanning alert. @@ -94353,6 +99391,7 @@ export interface operations { page?: components["parameters"]["page"]; per_page?: components["parameters"]["per-page"]; ref?: components["parameters"]["git-ref"]; + pr?: components["parameters"]["pr-alias"]; }; path: { owner: components["parameters"]["owner"]; @@ -94385,8 +99424,8 @@ export interface operations { * 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. + * > [!WARNING] + * > **Closing down notice:** The `tool_name` field is closing down 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. */ @@ -94397,6 +99436,7 @@ export interface operations { tool_guid?: components["parameters"]["tool-guid"]; page?: components["parameters"]["page"]; per_page?: components["parameters"]["per-page"]; + pr?: components["parameters"]["pr-alias"]; /** @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. */ @@ -94563,7 +99603,7 @@ export interface operations { * 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 `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/list-codeql-databases": { parameters: { @@ -94590,11 +99630,11 @@ export interface operations { * * 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 + * to [`application/zip`](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#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 `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-codeql-database": { parameters: { @@ -94618,6 +99658,138 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; + /** + * Delete a CodeQL database + * @description Deletes a CodeQL database for a language in a repository. + * + * 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-codeql-database": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** @description The language of the CodeQL database. */ + language: string; + }; + }; + responses: { + /** @description Response */ + 204: { + content: never; + }; + 403: components["responses"]["code_scanning_forbidden_write"]; + 404: components["responses"]["not_found"]; + 503: components["responses"]["service_unavailable"]; + }; + }; + /** + * Create a CodeQL variant analysis + * @description Creates a new CodeQL variant analysis, which will run a CodeQL query against one or more repositories. + * + * Get started by learning more about [running CodeQL queries at scale with Multi-Repository Variant Analysis](https://docs.github.com/code-security/codeql-for-vs-code/getting-started-with-codeql-for-vs-code/running-codeql-queries-at-scale-with-multi-repository-variant-analysis). + * + * Use the `owner` and `repo` parameters in the URL to specify the controller repository that + * will be used for running GitHub Actions workflows and storing the results of the CodeQL variant analysis. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + "code-scanning/create-variant-analysis": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + requestBody: { + content: { + "application/json": { + language: components["schemas"]["code-scanning-variant-analysis-language"]; + /** @description A Base64-encoded tarball containing a CodeQL query and all its dependencies */ + query_pack: string; + /** @description List of repository names (in the form `owner/repo-name`) to run the query against. Precisely one property from `repositories`, `repository_lists` and `repository_owners` is required. */ + repositories?: string[]; + /** @description List of repository lists to run the query against. Precisely one property from `repositories`, `repository_lists` and `repository_owners` is required. */ + repository_lists?: string[]; + /** @description List of organization or user names whose repositories the query should be run against. Precisely one property from `repositories`, `repository_lists` and `repository_owners` is required. */ + repository_owners?: string[]; + }; + }; + }; + responses: { + /** @description Variant analysis submitted for processing */ + 201: { + content: { + "application/json": components["schemas"]["code-scanning-variant-analysis"]; + }; + }; + 404: components["responses"]["not_found"]; + /** @description Unable to process variant analysis submission */ + 422: { + content: { + "application/json": components["schemas"]["basic-error"]; + }; + }; + 503: components["responses"]["service_unavailable"]; + }; + }; + /** + * Get the summary of a CodeQL variant analysis + * @description Gets the summary of a CodeQL variant analysis. + * + * 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-variant-analysis": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** @description The unique identifier of the variant analysis. */ + codeql_variant_analysis_id: number; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["code-scanning-variant-analysis"]; + }; + }; + 404: components["responses"]["not_found"]; + 503: components["responses"]["service_unavailable"]; + }; + }; + /** + * Get the analysis status of a repository in a CodeQL variant analysis + * @description Gets the analysis status of a repository in a CodeQL variant analysis. + * + * 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-variant-analysis-repo-task": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + /** @description The name of the controller repository. */ + repo: string; + /** @description The ID of the variant analysis. */ + codeql_variant_analysis_id: number; + /** @description The account owner of the variant analysis repository. The name is not case sensitive. */ + repo_owner: string; + /** @description The name of the variant analysis repository. */ + repo_name: string; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["code-scanning-variant-analysis-repo-task"]; + }; + }; + 404: components["responses"]["not_found"]; + 503: components["responses"]["service_unavailable"]; + }; + }; /** * Get a code scanning default setup configuration * @description Gets a code scanning default setup configuration. @@ -94714,6 +99886,8 @@ export interface operations { * 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. + * + * This endpoint is limited to 1,000 requests per hour for each user or app installation calling it. */ "code-scanning/upload-sarif": { parameters: { @@ -94799,6 +99973,34 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; + /** + * Get the code security configuration associated with a repository + * @description Get the code security configuration that manages a repository's code security settings. + * + * 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` scope to use this endpoint. + */ + "code-security/get-configuration-for-repository": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["code-security-configuration-for-repository"]; + }; + }; + 204: components["responses"]["no_content"]; + 304: components["responses"]["not_modified"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; /** * List CODEOWNERS errors * @description List any syntax errors that are detected in the CODEOWNERS @@ -94885,7 +100087,7 @@ export interface operations { /** @description The requested location for a new codespace. Best efforts are made to respect this upon creation. Assigned by IP if not provided. */ location?: string; /** - * @description The geographic area for this codespace. If not specified, the value is assigned by IP. This property replaces `location`, which is being deprecated. + * @description The geographic area for this codespace. If not specified, the value is assigned by IP. This property replaces `location`, which is closing down. * @enum {string} */ geo?: "EuropeWest" | "SoutheastAsia" | "UsEast" | "UsWest"; @@ -95113,8 +100315,6 @@ export interface operations { * @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": { @@ -95285,7 +100485,7 @@ export interface operations { }; /** * 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)." + * @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/using-the-rest-api/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)." * @@ -95364,7 +100564,8 @@ export interface operations { * - 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. * @@ -95620,7 +100821,8 @@ export interface operations { }; /** * 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`. + * @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). */ @@ -95652,6 +100854,7 @@ export interface operations { * | `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. | + * | `verified_at` | `string` | The date the signature was verified by GitHub. | * * These are the possible values for `reason` in the `verification` object: * @@ -95682,8 +100885,9 @@ export interface operations { author?: string; /** @description GitHub username or email address to use to filter by commit committer. */ committer?: string; - 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`. */ + /** @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`. Due to limitations of Git, timestamps must be between 1970-01-01 and 2099-12-31 (inclusive) or unexpected results may be returned. */ + since?: string; + /** @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`. Due to limitations of Git, timestamps must be between 1970-01-01 and 2099-12-31 (inclusive) or unexpected results may be returned. */ until?: string; per_page?: components["parameters"]["per-page"]; page?: components["parameters"]["page"]; @@ -95773,7 +100977,7 @@ 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 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/using-the-rest-api/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)." * @@ -95799,7 +101003,7 @@ export interface operations { path?: string; /** @description Line index in the diff to comment on. */ position?: number; - /** @description **Deprecated**. Use **position** parameter instead. Line number in the file to comment on. */ + /** @description **Closing down notice**. Use **position** parameter instead. Line number in the file to comment on. */ line?: number; }; }; @@ -95854,7 +101058,8 @@ 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 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. * @@ -95872,6 +101077,7 @@ export interface operations { * | `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. | + * | `verified_at` | `string` | The date the signature was verified by GitHub. | * * These are the possible values for `reason` in the `verification` object: * @@ -95921,7 +101127,8 @@ export interface operations { * 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. * @@ -95963,7 +101170,8 @@ 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`. + * > [!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. */ @@ -96113,7 +101321,7 @@ export interface operations { * * 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 list of changed files is only shown on the first page of results, and it includes up to 300 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)." @@ -96128,6 +101336,7 @@ export interface operations { * | `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. | + * | `verified_at` | `string` | The date the signature was verified by GitHub. | * * These are the possible values for `reason` in the `verification` object: * @@ -96226,6 +101435,7 @@ export interface operations { }; }; 302: components["responses"]["found"]; + 304: components["responses"]["not_modified"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; }; @@ -96234,7 +101444,8 @@ export interface operations { * 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. */ @@ -96293,7 +101504,14 @@ export interface operations { }; }; 404: components["responses"]["not_found"]; - 409: components["responses"]["conflict"]; + /** @description Conflict */ + 409: { + content: { + "application/json": + | components["schemas"]["basic-error"] + | components["schemas"]["repository-rule-violation-error"]; + }; + }; 422: components["responses"]["validation_failed"]; }; }; @@ -96307,7 +101525,8 @@ export interface operations { * * 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. */ "repos/delete-file": { parameters: { @@ -96411,7 +101630,7 @@ export interface operations { direction?: components["parameters"]["direction"]; /** * @deprecated - * @description **Deprecated**. Page number of the results to fetch. Use cursor-based pagination with `before` or `after` instead. + * @description **Closing down notice**. Page number of the results to fetch. Use cursor-based pagination with `before` or `after` instead. */ page?: number; /** @@ -97019,7 +102238,10 @@ export interface operations { | "pending" | "success"; /** - * @description The target URL to associate with this status. This URL should contain output to keep the user updated while the task is running or serve as historical information for what happened in the deployment. **Note:** It's recommended to use the `log_url` parameter, which replaces `target_url`. + * @description The target URL to associate with this status. This URL should contain output to keep the user updated while the task is running or serve as historical information for what happened in the deployment. + * + * > [!NOTE] + * > It's recommended to use the `log_url` parameter, which replaces `target_url`. * @default */ target_url?: string; @@ -97104,7 +102326,7 @@ export interface operations { "application/json": { /** @description A custom webhook event name. Must be 100 characters or fewer. */ event_type: string; - /** @description JSON payload with extra information about the webhook event that your action or workflow may use. The maximum number of top-level properties is 10. */ + /** @description JSON payload with extra information about the webhook event that your action or workflow may use. The maximum number of top-level properties is 10. The total size of the JSON payload must be less than 64KB. */ client_payload?: { [key: string]: unknown; }; @@ -97157,7 +102379,8 @@ 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)." + * @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. * @@ -97184,9 +102407,11 @@ export interface operations { * 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. */ @@ -97470,7 +102695,9 @@ export interface operations { }; /** * 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. + * @description Gets all custom deployment protection rule integrations that are available for an environment. + * + * The authenticated user must have admin or owner permissions to the repository to 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)." * @@ -97865,7 +103092,8 @@ export interface operations { }; /** * 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. + * @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: { @@ -97918,9 +103146,11 @@ export interface operations { * 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. */ "repos/create-fork": { parameters: { @@ -97989,7 +103219,14 @@ export interface operations { 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; 409: components["responses"]["conflict"]; - 422: components["responses"]["validation_failed"]; + /** @description Validation failed */ + 422: { + content: { + "application/json": + | components["schemas"]["validation-error"] + | components["schemas"]["repository-rule-violation-error"]; + }; + }; }; }; /** @@ -98038,6 +103275,7 @@ export interface operations { * | `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. | + * | `verified_at` | `string` | The date the signature was verified by GitHub. | * * These are the possible values for `reason` in the `verification` object: * @@ -98071,7 +103309,7 @@ export interface operations { message: string; /** @description The SHA of the tree object this commit points to */ tree: string; - /** @description The SHAs of the commits that were the parents of this commit. If omitted or empty, the commit will be written as a root commit. For a single parent, an array of one SHA should be provided; for a merge commit, an array of more than one should be provided. */ + /** @description The full SHAs of the commits that were the parents of this commit. If omitted or empty, the commit will be written as a root commit. For a single parent, an array of one SHA should be provided; for a merge commit, an array of more than one should be provided. */ parents?: string[]; /** @description Information about the author of the commit. By default, the `author` will be the authenticated user and the current date. See the `author` and `committer` object below for details. */ author?: { @@ -98134,6 +103372,7 @@ export interface operations { * | `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. | + * | `verified_at` | `string` | The date the signature was verified by GitHub. | * * These are the possible values for `reason` in the `verification` object: * @@ -98178,7 +103417,8 @@ export interface operations { * * 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`. */ @@ -98207,7 +103447,8 @@ 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/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)". */ "git/get-ref": { parameters: { @@ -98335,6 +103576,7 @@ export interface operations { * | `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. | + * | `verified_at` | `string` | The date the signature was verified by GitHub. | * * These are the possible values for `reason` in the `verification` object: * @@ -98417,6 +103659,7 @@ export interface operations { * | `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. | + * | `verified_at` | `string` | The date the signature was verified by GitHub. | * * These are the possible values for `reason` in the `verification` object: * @@ -98531,8 +103774,8 @@ export interface operations { * * 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. */ "git/get-tree": { parameters: { @@ -98664,7 +103907,12 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** Delete a repository webhook */ + /** + * Delete a repository webhook + * @description Delete a webhook for an organization. + * + * The authenticated user must be a repository owner, or have admin access in the repository, to delete the webhook. + */ "repos/delete-webhook": { parameters: { path: { @@ -98792,7 +104040,6 @@ export interface operations { query?: { per_page?: components["parameters"]["per-page"]; cursor?: components["parameters"]["cursor"]; - redelivery?: boolean; }; path: { owner: components["parameters"]["owner"]; @@ -98878,7 +104125,8 @@ export interface operations { * 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` */ "repos/test-push-webhook": { parameters: { @@ -98901,7 +104149,8 @@ export interface operations { * @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] + * > **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down 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** * @@ -98961,7 +104210,8 @@ export interface operations { * 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] + * > **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down 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: { @@ -99010,7 +104260,8 @@ export interface operations { * @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] + * > **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down 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: { @@ -99037,7 +104288,8 @@ export interface operations { * 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] + * > **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down 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: { @@ -99084,7 +104336,8 @@ export interface operations { * * 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] + * > **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down 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: { @@ -99113,7 +104366,8 @@ export interface operations { * @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). + * > [!WARNING] + * > **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down 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: { @@ -99150,7 +104404,8 @@ export interface operations { * @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] + * > **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down 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: { @@ -99178,7 +104433,8 @@ export interface operations { * 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] + * > **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down 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: { @@ -99382,10 +104638,8 @@ export interface operations { * 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)." * @@ -99439,7 +104693,7 @@ export interface operations { * 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)" + * 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/using-the-rest-api/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)." @@ -99463,7 +104717,7 @@ export interface operations { title: string | number; /** @description The contents of the issue. */ 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.**_ */ + /** @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 closing down.**_ */ assignee?: string | 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._ */ @@ -99717,7 +104971,8 @@ export interface operations { }; /** * 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`. + * @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). */ @@ -99798,10 +105053,8 @@ export interface operations { * 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)." * @@ -99833,7 +105086,7 @@ export interface operations { }; /** * Update an issue - * @description Issue owners and users with push access can edit an issue. + * @description Issue owners and users with push access or Triage role 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)." * @@ -99857,7 +105110,7 @@ export interface operations { title?: string | number | null; /** @description The contents of the issue. */ body?: string | null; - /** @description Username to assign to this issue. **This field is deprecated.** */ + /** @description Username to assign to this issue. **This field is closing down.** */ assignee?: string | null; /** * @description The open or closed state of the issue. @@ -100037,7 +105290,7 @@ export interface operations { * * 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)" + * For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/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)." @@ -100421,7 +105674,8 @@ export interface operations { }; /** * 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`. + * @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). */ @@ -100441,6 +105695,173 @@ export interface operations { }; }; }; + /** + * Remove sub-issue + * @description You can use the REST API to remove a sub-issue from an issue. + * Removing 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/using-the-rest-api/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 a specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response 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/remove-sub-issue": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + issue_number: components["parameters"]["issue-number"]; + }; + }; + requestBody: { + content: { + "application/json": { + /** @description The sub-issue to remove */ + sub_issue_id: number; + }; + }; + }; + responses: { + /** @description Response */ + 200: { + headers: { + /** @example https://api.github.com/repos/octocat/Hello-World/issues/1/sub-issue */ + Location?: string; + }; + content: { + "application/json": components["schemas"]["issue"]; + }; + }; + 400: components["responses"]["bad_request"]; + 404: components["responses"]["not_found"]; + }; + }; + /** + * List sub-issues + * @description You can use the REST API to list the sub-issues on 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/list-sub-issues": { + parameters: { + query?: { + per_page?: components["parameters"]["per-page"]; + page?: components["parameters"]["page"]; + }; + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + issue_number: components["parameters"]["issue-number"]; + }; + }; + responses: { + /** @description Response */ + 200: { + headers: { + Link: components["headers"]["link"]; + }; + content: { + "application/json": components["schemas"]["issue"][]; + }; + }; + 404: components["responses"]["not_found"]; + 410: components["responses"]["gone"]; + }; + }; + /** + * Add sub-issue + * @description You can use the REST API to add sub-issues to issues. + * + * 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/using-the-rest-api/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/add-sub-issue": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + issue_number: components["parameters"]["issue-number"]; + }; + }; + requestBody: { + content: { + "application/json": { + /** @description The sub-issue to add */ + sub_issue_id: number; + /** @description Option that, when true, instructs the operation to replace the sub-issues current parent issue */ + replace_parent?: boolean; + }; + }; + }; + responses: { + /** @description Response */ + 201: { + headers: { + /** @example https://api.github.com/repos/octocat/Hello-World/issues/sub-issues/1 */ + Location?: string; + }; + content: { + "application/json": components["schemas"]["issue"]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 410: components["responses"]["gone"]; + 422: components["responses"]["validation_failed"]; + }; + }; + /** + * Reprioritize sub-issue + * @description You can use the REST API to reprioritize a sub-issue to a different position in the parent list. + */ + "issues/reprioritize-sub-issue": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + issue_number: components["parameters"]["issue-number"]; + }; + }; + requestBody: { + content: { + "application/json": { + /** @description The id of the sub-issue to reprioritize */ + sub_issue_id: number; + /** @description The id of the sub-issue to be prioritized after (either positional argument after OR before should be specified). */ + after_id?: number; + /** @description The id of the sub-issue to be prioritized before (either positional argument after OR before should be specified). */ + before_id?: number; + }; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["issue"]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed_simple"]; + 503: components["responses"]["service_unavailable"]; + }; + }; /** * List timeline events for an issue * @description List all timeline events for an issue. @@ -101142,7 +106563,7 @@ export interface operations { 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/)." */ + /** @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/pages/configuring-a-custom-domain-for-your-github-pages-site)." */ cname?: string | null; /** @description Specify whether HTTPS should be enforced for the repository. */ https_enforced?: boolean; @@ -101713,7 +107134,7 @@ export interface operations { * * 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/using-the-rest-api/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)." * @@ -101986,7 +107407,8 @@ export interface operations { }; /** * 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.` + * @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). */ @@ -102022,7 +107444,7 @@ export interface operations { * * 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/using-the-rest-api/getting-started-with-the-rest-api#media-types) 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)." * @@ -102041,7 +107463,7 @@ export interface operations { }; }; 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. */ + /** @description Pass the appropriate [media type](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types) to fetch diff and patch formats. */ 200: { content: { "application/json": components["schemas"]["pull-request"]; @@ -102125,7 +107547,7 @@ export interface operations { /** @description The requested location for a new codespace. Best efforts are made to respect this upon creation. Assigned by IP if not provided. */ location?: string; /** - * @description The geographic area for this codespace. If not specified, the value is assigned by IP. This property replaces `location`, which is being deprecated. + * @description The geographic area for this codespace. If not specified, the value is assigned by IP. This property replaces `location`, which is closing down. * @enum {string} */ geo?: "EuropeWest" | "SoutheastAsia" | "UsEast" | "UsWest"; @@ -102213,9 +107635,9 @@ export interface operations { * * 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 closing down. 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)" + * 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/using-the-rest-api/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)." @@ -102244,7 +107666,7 @@ export interface operations { path: string; /** * @deprecated - * @description **This parameter is deprecated. Use `line` instead**. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the 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. + * @description **This parameter is closing down. Use `line` instead**. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the 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. */ position?: number; /** @@ -102293,7 +107715,7 @@ export interface operations { * 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)" + * 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/using-the-rest-api/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)." @@ -102375,8 +107797,8 @@ 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. + * > [!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)." * @@ -102438,7 +107860,7 @@ export interface operations { /** * 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/using-the-rest-api/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: { @@ -102626,11 +108048,12 @@ 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)." + * 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/using-the-rest-api/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. + * > [!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. * @@ -102832,9 +108255,8 @@ export interface operations { * 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)." * @@ -102924,6 +108346,7 @@ export interface operations { /** * 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. + * Note: If making a request on behalf of a GitHub App you must also have permissions to write the contents of the head repository. */ "pulls/update-branch": { parameters: { @@ -102982,6 +108405,7 @@ export interface operations { "application/json": components["schemas"]["content-file"]; }; }; + 304: components["responses"]["not_modified"]; 404: components["responses"]["not_found"]; 422: components["responses"]["validation_failed"]; }; @@ -103053,7 +108477,7 @@ export interface operations { * 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/using-the-rest-api/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: { @@ -103121,7 +108545,13 @@ export interface operations { }; /** * 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. + * @description To download the asset's binary content: + * + * - If within a browser, fetch the location specified in the `browser_download_url` key provided in the response. + * - Alternatively, set the `Accept` header of the request to + * [`application/octet-stream`](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#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: { @@ -103275,9 +108705,8 @@ export interface operations { * 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)." */ "repos/get-release": { parameters: { @@ -103521,7 +108950,8 @@ export interface operations { }; /** * 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`. + * @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). */ @@ -103580,6 +109010,7 @@ export interface operations { page?: components["parameters"]["page"]; /** @description Include rulesets configured at higher levels that apply to this repository */ includes_parents?: boolean; + targets?: components["parameters"]["ruleset-targets"]; }; path: { owner: components["parameters"]["owner"]; @@ -103616,8 +109047,7 @@ export interface operations { name: string; /** * @description The target of the ruleset - * - * **Note**: The `push` target is in beta and is subject to change. + * @default branch * @enum {string} */ target?: "branch" | "tag" | "push"; @@ -103699,6 +109129,9 @@ export interface operations { /** * Get a repository ruleset * @description Get a ruleset for a repository. + * + * **Note:** To prevent leaking sensitive information, the `bypass_actors` property is only returned if the user + * making the API request has write access to the ruleset. */ "repos/get-repo-ruleset": { parameters: { @@ -103745,8 +109178,6 @@ export interface operations { name?: string; /** * @description The target of the ruleset - * - * **Note**: The `push` target is in beta and is subject to change. * @enum {string} */ target?: "branch" | "tag" | "push"; @@ -103813,6 +109244,8 @@ export interface operations { before?: components["parameters"]["secret-scanning-pagination-before-org-repo"]; after?: components["parameters"]["secret-scanning-pagination-after-org-repo"]; validity?: components["parameters"]["secret-scanning-alert-validity"]; + is_publicly_leaked?: components["parameters"]["secret-scanning-alert-publicly-leaked"]; + is_multi_repo?: components["parameters"]["secret-scanning-alert-multi-repo"]; }; path: { owner: components["parameters"]["owner"]; @@ -103948,6 +109381,78 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; + /** + * Create a push protection bypass + * @description Creates a bypass for a previously push protected secret. + * + * The authenticated user must be the original author of the committed secret. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + "secret-scanning/create-push-protection-bypass": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + requestBody: { + content: { + "application/json": { + reason: components["schemas"]["secret-scanning-push-protection-bypass-reason"]; + placeholder_id: components["schemas"]["secret-scanning-push-protection-bypass-placeholder-id"]; + }; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["secret-scanning-push-protection-bypass"]; + }; + }; + /** @description User does not have enough permissions to perform this action. */ + 403: { + content: never; + }; + /** @description Placeholder ID not found, or push protection is disabled on this repository. */ + 404: { + content: never; + }; + /** @description Bad request, input data missing or incorrect. */ + 422: { + content: never; + }; + 503: components["responses"]["service_unavailable"]; + }; + }; + /** + * Get secret scanning scan history for a repository + * @description Lists the latest default incremental and backfill scans by type for a repository. Scans from Copilot Secret Scanning are not included. + * + * 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-scan-history": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["secret-scanning-scan-history"]; + }; + }; + /** @description Repository does not have GitHub Advanced Security or secret scanning enabled */ + 404: { + content: never; + }; + 503: components["responses"]["service_unavailable"]; + }; + }; /** * List repository security advisories * @description Lists security advisories in a repository. @@ -104145,7 +109650,8 @@ export interface operations { * 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. */ "security-advisories/create-fork": { parameters: { @@ -104204,11 +109710,10 @@ export interface operations { }; /** * Get the weekly commit activity - * @description - * Returns a weekly aggregate of the number of additions and deletions pushed to a repository. + * @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. + * > [!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: { @@ -104264,7 +109769,8 @@ export interface operations { * * `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. */ "repos/get-contributors-stats": { parameters: { @@ -104512,8 +110018,12 @@ export interface operations { }; }; /** - * List tag protection states for a repository - * @description This returns the tag protection states of a repository. + * Closing down - List tag protection states for a repository + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** This operation is closing down and will be removed after August 30, 2024. Use the "[Repository Rulesets](https://docs.github.com/rest/repos/rules#get-all-repository-rulesets)" endpoint instead. + * + * This returns the tag protection states of a repository. * * This information is only available to repository administrators. */ @@ -104536,8 +110046,12 @@ export interface operations { }; }; /** - * Create a tag protection state for a repository - * @description This creates a tag protection state for a repository. + * Closing down - Create a tag protection state for a repository + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** This operation is closing down and will be removed after August 30, 2024. Use the "[Repository Rulesets](https://docs.github.com/rest/repos/rules#create-a-repository-ruleset)" endpoint instead. + * + * This creates a tag protection state for a repository. * This endpoint is only available to repository administrators. */ "repos/create-tag-protection": { @@ -104567,8 +110081,12 @@ export interface operations { }; }; /** - * Delete a tag protection state for a repository - * @description This deletes a tag protection state for a repository. + * Closing down - Delete a tag protection state for a repository + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** This operation is closing down and will be removed after August 30, 2024. Use the "[Repository Rulesets](https://docs.github.com/rest/repos/rules#delete-a-repository-ruleset)" endpoint instead. + * + * This deletes a tag protection state for a repository. * This endpoint is only available to repository administrators. */ "repos/delete-tag-protection": { @@ -104593,7 +110111,9 @@ export interface operations { * @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. + * + * > [!NOTE] + * > For private repositories, these links are temporary and expire after five minutes. */ "repos/download-tarball-archive": { parameters: { @@ -104679,7 +110199,7 @@ export interface operations { requestBody: { content: { "application/json": { - /** @description An array of topics to add to the repository. Pass one or more topics to _replace_ the set of existing topics. Send an empty array (`[]`) to clear all topics from the repository. **Note:** Topic `names` cannot contain uppercase letters. */ + /** @description An array of topics to add to the repository. Pass one or more topics to _replace_ the set of existing topics. Send an empty array (`[]`) to clear all topics from the repository. **Note:** Topic `names` will be saved as lowercase. */ names: string[]; }; }; @@ -104883,7 +110403,8 @@ export interface operations { * `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. */ "repos/download-zipball-archive": { parameters: { @@ -105013,12 +110534,12 @@ export interface operations { q: string; /** * @deprecated - * @description **This field is deprecated.** Sorts the results of your query. Can only be `indexed`, which indicates how recently a file has been indexed by the GitHub search infrastructure. Default: [best match](https://docs.github.com/rest/search/search#ranking-search-results) + * @description **This field is closing down.** Sorts the results of your query. Can only be `indexed`, which indicates how recently a file has been indexed by the GitHub search infrastructure. Default: [best match](https://docs.github.com/rest/search/search#ranking-search-results) */ sort?: "indexed"; /** * @deprecated - * @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`. + * @description **This field is closing down.** 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"; per_page?: components["parameters"]["per-page"]; @@ -105092,7 +110613,8 @@ export interface operations { * * 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)." */ "search/issues-and-pull-requests": { parameters: { @@ -105297,7 +110819,8 @@ export interface operations { /** * 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. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down 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: { @@ -105318,7 +110841,8 @@ export interface operations { /** * 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. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down 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. * @@ -105342,11 +110866,13 @@ export interface operations { /** * 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. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down 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`. + * > [!NOTE] + * > With nested teams, the `privacy` for parent teams cannot be `secret`. */ "teams/update-legacy": { parameters: { @@ -105381,7 +110907,7 @@ export interface operations { | "notifications_enabled" | "notifications_disabled"; /** - * @description **Deprecated**. The permission that new repositories will be added to the team with when none is specified. + * @description **Closing down notice**. The permission that new repositories will be added to the team with when none is specified. * @default pull * @enum {string} */ @@ -105412,7 +110938,8 @@ export interface operations { /** * 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. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down 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. * @@ -105444,11 +110971,12 @@ 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. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down 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)." + * 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/using-the-rest-api/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. */ @@ -105485,7 +111013,8 @@ export interface operations { /** * 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. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down 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. * @@ -105510,7 +111039,8 @@ export interface operations { /** * 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. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down 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. * @@ -105533,7 +111063,8 @@ export interface operations { /** * 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. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down 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. * @@ -105568,7 +111099,8 @@ export interface operations { /** * 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. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down 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. * @@ -105601,11 +111133,12 @@ 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. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down 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)." + * 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/using-the-rest-api/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. */ @@ -105636,7 +111169,8 @@ export interface operations { /** * 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. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down 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. * @@ -105662,7 +111196,8 @@ export interface operations { /** * 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. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down 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. * @@ -105686,7 +111221,8 @@ export interface operations { /** * 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. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down 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. * @@ -105720,7 +111256,8 @@ export interface operations { /** * 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. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down 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). * @@ -105763,7 +111300,8 @@ 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. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down 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). * @@ -105810,7 +111348,8 @@ export interface operations { /** * 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. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down 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). * @@ -105852,7 +111391,8 @@ 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. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down 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). * @@ -105898,7 +111438,8 @@ export interface operations { /** * 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. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down 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`. */ @@ -105927,7 +111468,8 @@ 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. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down 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. */ @@ -105959,7 +111501,7 @@ export interface operations { /** * Get team member (Legacy) * @deprecated - * @description The "Get team member" endpoint (described below) is deprecated. + * @description The "Get team member" endpoint (described below) is closing down. * * 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. * @@ -105986,7 +111528,7 @@ export interface operations { /** * Add team member (Legacy) * @deprecated - * @description The "Add team member" endpoint (described below) is deprecated. + * @description The "Add team member" endpoint (described below) is closing down. * * 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. * @@ -105994,7 +111536,8 @@ export interface operations { * * 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)." */ @@ -106024,7 +111567,7 @@ export interface operations { /** * Remove team member (Legacy) * @deprecated - * @description The "Remove team member" endpoint (described below) is deprecated. + * @description The "Remove team member" endpoint (described below) is closing down. * * 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. * @@ -106032,7 +111575,8 @@ export interface operations { * * 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/)." */ "teams/remove-member-legacy": { parameters: { @@ -106055,7 +111599,8 @@ export interface operations { /** * 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. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down 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. * @@ -106086,13 +111631,15 @@ export interface operations { /** * 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. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down 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/)." + * > [!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. * @@ -106138,13 +111685,15 @@ export interface operations { /** * 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. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down 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/)." + * > [!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: { @@ -106167,7 +111716,8 @@ export interface operations { /** * 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. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down 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. */ @@ -106197,7 +111747,8 @@ export interface operations { /** * 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. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down 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. */ @@ -106224,7 +111775,8 @@ export interface operations { /** * 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. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down 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. */ @@ -106267,7 +111819,8 @@ export interface operations { /** * 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. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down 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. */ @@ -106290,7 +111843,8 @@ export interface operations { /** * 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. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down 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: { @@ -106318,11 +111872,13 @@ export interface operations { /** * Check team permissions for a repository (Legacy) * @deprecated - * @description **Note**: Repositories inherited through a parent team will also be checked. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down 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. + * > [!NOTE] + * > 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 `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/using-the-rest-api/getting-started-with-the-rest-api#media-types/) via the `Accept` header: */ "teams/check-permissions-for-repo-legacy": { parameters: { @@ -106352,7 +111908,8 @@ export interface operations { /** * 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. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down 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. * @@ -106389,7 +111946,8 @@ export interface operations { /** * 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. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down 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. */ @@ -106411,7 +111969,8 @@ export interface operations { /** * 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. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down 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: { @@ -106661,7 +112220,7 @@ export interface operations { /** @description The requested location for a new codespace. Best efforts are made to respect this upon creation. Assigned by IP if not provided. */ location?: string; /** - * @description The geographic area for this codespace. If not specified, the value is assigned by IP. This property replaces `location`, which is being deprecated. + * @description The geographic area for this codespace. If not specified, the value is assigned by IP. This property replaces `location`, which is closing down. * @enum {string} */ geo?: "EuropeWest" | "SoutheastAsia" | "UsEast" | "UsWest"; @@ -106693,7 +112252,7 @@ export interface operations { /** @description The requested location for a new codespace. Best efforts are made to respect this upon creation. Assigned by IP if not provided. */ location?: string; /** - * @description The geographic area for this codespace. If not specified, the value is assigned by IP. This property replaces `location`, which is being deprecated. + * @description The geographic area for this codespace. If not specified, the value is assigned by IP. This property replaces `location`, which is closing down. * @enum {string} */ geo?: "EuropeWest" | "SoutheastAsia" | "UsEast" | "UsWest"; @@ -107472,6 +113031,7 @@ export interface operations { 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; }; }; /** @@ -107677,6 +113237,8 @@ export interface operations { /** * 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. + * + * This endpoint only works for PATs (classic) with the `repo` scope. */ "apps/add-repo-to-installation-for-authenticated-user": { parameters: { @@ -107698,6 +113260,8 @@ export interface operations { /** * 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`. + * + * This endpoint only works for PATs (classic) with the `repo` scope. */ "apps/remove-repo-from-installation-for-authenticated-user": { parameters: { @@ -107776,10 +113340,8 @@ export interface operations { * 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)." * @@ -108311,6 +113873,9 @@ export interface operations { * @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. + * + * > [!NOTE] + * > Requests using a fine-grained access token will receive a `200 Success` response with an empty list. */ "orgs/list-for-authenticated-user": { parameters: { @@ -108338,7 +113903,7 @@ export interface operations { * 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. For more information, 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: { @@ -108370,7 +113935,7 @@ export interface operations { * 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. For more information, 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: { @@ -108392,7 +113957,7 @@ export interface operations { * 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. For more information, 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: { @@ -108419,7 +113984,7 @@ export interface operations { * - 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. For more information, 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: { @@ -108446,7 +114011,7 @@ export interface operations { * 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. For more information, 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: { @@ -108477,7 +114042,7 @@ export interface operations { * 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. For more information, 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: { @@ -108502,7 +114067,7 @@ export interface operations { * * 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. For more information, 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: { @@ -108530,7 +114095,7 @@ export interface operations { * - 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. For more information, 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: { @@ -108754,7 +114319,9 @@ export interface operations { */ delete_branch_on_merge?: boolean; /** - * @description The default value for a squash merge commit title: + * @description Required when using `squash_merge_commit_message`. + * + * The default value for a squash merge commit title: * * - `PR_TITLE` - default to the pull request's title. * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). @@ -108771,7 +114338,9 @@ export interface operations { */ squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** - * @description The default value for a merge commit title. + * @description Required when using `merge_commit_message`. + * + * The default value for a merge commit title. * * - `PR_TITLE` - default to the pull request's title. * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). @@ -109245,6 +114814,32 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; + /** + * Get a user using their ID + * @description Provides publicly available information about someone with a GitHub account. This method takes their durable user `ID` instead of their `login`, which can change over time. + * + * 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-id": { + parameters: { + path: { + account_id: components["parameters"]["account-id"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": + | components["schemas"]["private-user"] + | components["schemas"]["public-user"]; + }; + }; + 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. @@ -109298,6 +114893,53 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; + /** + * List attestations + * @description List a collection of artifact attestations with a given subject digest that are associated with repositories owned by a user. + * + * The collection of attestations returned by this endpoint is filtered according to the authenticated user's permissions; if the authenticated user cannot read a repository, the attestations associated with that repository will not be included in the response. In addition, when using a fine-grained access token the `attestations:read` permission is required. + * + * **Please note:** in order to offer meaningful security benefits, an attestation's signature and timestamps **must** be cryptographically verified, and the identity of the attestation signer **must** be validated. Attestations can be verified using the [GitHub CLI `attestation verify` command](https://cli.github.com/manual/gh_attestation_verify). For more information, see [our guide on how to use artifact attestations to establish a build's provenance](https://docs.github.com/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds). + */ + "users/list-attestations": { + parameters: { + query?: { + per_page?: components["parameters"]["per-page"]; + before?: components["parameters"]["pagination-before"]; + after?: components["parameters"]["pagination-after"]; + }; + path: { + username: components["parameters"]["username"]; + /** @description Subject Digest */ + subject_digest: string; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": { + attestations?: { + bundle?: components["schemas"]["sigstore-bundle-0"]; + repository_id?: number; + bundle_url?: string; + }[]; + }; + }; + }; + /** @description Response */ + 201: { + content: { + "application/json": components["schemas"]["empty-object"]; + }; + }; + /** @description Response */ + 204: { + content: never; + }; + 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. @@ -109323,7 +114965,10 @@ export interface operations { }; /** * 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. + * @description If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events. _Optional_: use the fine-grained token with following permission set to view private events: "Events" user permissions (read). + * + * > [!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-events-for-authenticated-user": { parameters: { @@ -109347,6 +114992,9 @@ export interface operations { /** * 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. + * + * > [!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-org-events-for-authenticated-user": { parameters: { @@ -109368,7 +115016,11 @@ export interface operations { }; }; }; - /** List public events for a user */ + /** + * List public events for a user + * @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-public-events-for-user": { parameters: { query?: { @@ -109623,7 +115275,7 @@ 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)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, 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: { @@ -109660,7 +115312,7 @@ export interface operations { * 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. For more information, 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: { @@ -109685,7 +115337,7 @@ export interface operations { * * 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. For more information, 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: { @@ -109715,7 +115367,7 @@ export interface operations { * * 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. For more information, 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: { @@ -109743,7 +115395,7 @@ export interface operations { * 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. For more information, 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: { @@ -109769,7 +115421,7 @@ export interface operations { * 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. For more information, 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: { @@ -109795,7 +115447,7 @@ export interface operations { * * 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. For more information, 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: { @@ -109826,7 +115478,7 @@ export interface operations { * * 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. For more information, 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: { @@ -109878,7 +115530,11 @@ export interface operations { }; /** * 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. + * @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. + * + * > [!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-received-events-for-user": { parameters: { @@ -109899,7 +115555,11 @@ export interface operations { }; }; }; - /** List public events received by a user */ + /** + * List public events received by a user + * @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-received-public-events-for-user": { parameters: { query?: { @@ -110228,4 +115888,37 @@ export interface operations { 500: components["responses"]["internal_error"]; }; }; + /** + * 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: { + path: { + org: components["parameters"]["org"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": { + name: string; + description: string; + }[]; + }; + }; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + }; + }; } diff --git a/node_modules/@actions/github/node_modules/@octokit/types/dist-types/VERSION.d.ts b/node_modules/@actions/github/node_modules/@octokit/types/dist-types/VERSION.d.ts index e36ca410..9d5f7d51 100644 --- a/node_modules/@actions/github/node_modules/@octokit/types/dist-types/VERSION.d.ts +++ b/node_modules/@actions/github/node_modules/@octokit/types/dist-types/VERSION.d.ts @@ -1 +1 @@ -export declare const VERSION = "13.6.2"; +export declare const VERSION = "13.7.0"; diff --git a/node_modules/@actions/github/node_modules/@octokit/types/dist-types/generated/Endpoints.d.ts b/node_modules/@actions/github/node_modules/@octokit/types/dist-types/generated/Endpoints.d.ts index 837e68ae..8adbfec5 100644 --- a/node_modules/@actions/github/node_modules/@octokit/types/dist-types/generated/Endpoints.d.ts +++ b/node_modules/@actions/github/node_modules/@octokit/types/dist-types/generated/Endpoints.d.ts @@ -75,6 +75,10 @@ export interface Endpoints { * @see https://docs.github.com/rest/apps/oauth-applications#delete-an-app-token */ "DELETE /applications/{client_id}/token": Operation<"/applications/{client_id}/token", "delete">; + /** + * @see https://docs.github.com/rest/code-security/configurations#delete-a-code-security-configuration-for-an-enterprise + */ + "DELETE /enterprises/{enterprise}/code-security/configurations/{configuration_id}": Operation<"/enterprises/{enterprise}/code-security/configurations/{configuration_id}", "delete">; /** * @see https://docs.github.com/rest/gists/gists#delete-a-gist */ @@ -107,6 +111,18 @@ export interface Endpoints { * @see https://docs.github.com/rest/actions/permissions#disable-a-selected-repository-for-github-actions-in-an-organization */ "DELETE /orgs/{org}/actions/permissions/repositories/{repository_id}": Operation<"/orgs/{org}/actions/permissions/repositories/{repository_id}", "delete">; + /** + * @see https://docs.github.com/rest/actions/self-hosted-runner-groups#delete-a-self-hosted-runner-group-from-an-organization + */ + "DELETE /orgs/{org}/actions/runner-groups/{runner_group_id}": Operation<"/orgs/{org}/actions/runner-groups/{runner_group_id}", "delete">; + /** + * @see https://docs.github.com/rest/actions/self-hosted-runner-groups#remove-repository-access-to-a-self-hosted-runner-group-in-an-organization + */ + "DELETE /orgs/{org}/actions/runner-groups/{runner_group_id}/repositories/{repository_id}": Operation<"/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories/{repository_id}", "delete">; + /** + * @see https://docs.github.com/rest/actions/self-hosted-runner-groups#remove-a-self-hosted-runner-from-a-group-for-an-organization + */ + "DELETE /orgs/{org}/actions/runner-groups/{runner_group_id}/runners/{runner_id}": Operation<"/orgs/{org}/actions/runner-groups/{runner_group_id}/runners/{runner_id}", "delete">; /** * @see https://docs.github.com/rest/actions/self-hosted-runners#delete-a-self-hosted-runner-from-an-organization */ @@ -139,6 +155,14 @@ export interface Endpoints { * @see https://docs.github.com/rest/orgs/blocking#unblock-a-user-from-an-organization */ "DELETE /orgs/{org}/blocks/{username}": Operation<"/orgs/{org}/blocks/{username}", "delete">; + /** + * @see https://docs.github.com/rest/code-security/configurations#detach-configurations-from-repositories + */ + "DELETE /orgs/{org}/code-security/configurations/detach": Operation<"/orgs/{org}/code-security/configurations/detach", "delete">; + /** + * @see https://docs.github.com/rest/code-security/configurations#delete-a-code-security-configuration + */ + "DELETE /orgs/{org}/code-security/configurations/{configuration_id}": Operation<"/orgs/{org}/code-security/configurations/{configuration_id}", "delete">; /** * @see https://docs.github.com/rest/codespaces/organizations#remove-users-from-codespaces-access-for-an-organization */ @@ -215,10 +239,6 @@ export interface Endpoints { * @see https://docs.github.com/rest/orgs/organization-roles#remove-an-organization-role-from-a-user */ "DELETE /orgs/{org}/organization-roles/users/{username}/{role_id}": Operation<"/orgs/{org}/organization-roles/users/{username}/{role_id}", "delete">; - /** - * @see https://docs.github.com/rest/orgs/organization-roles#delete-a-custom-organization-role - */ - "DELETE /orgs/{org}/organization-roles/{role_id}": Operation<"/orgs/{org}/organization-roles/{role_id}", "delete">; /** * @see https://docs.github.com/rest/orgs/outside-collaborators#remove-outside-collaborator-from-an-organization */ @@ -231,6 +251,10 @@ export interface Endpoints { * @see https://docs.github.com/rest/packages/packages#delete-package-version-for-an-organization */ "DELETE /orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}": Operation<"/orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}", "delete">; + /** + * @see https://docs.github.com/rest/private-registries/organization-configurations#delete-a-private-registry-for-an-organization + */ + "DELETE /orgs/{org}/private-registries/{secret_name}": Operation<"/orgs/{org}/private-registries/{secret_name}", "delete">; /** * @see https://docs.github.com/rest/orgs/custom-properties#remove-a-custom-property-for-an-organization */ @@ -391,6 +415,10 @@ export interface Endpoints { * @see https://docs.github.com/rest/code-scanning/code-scanning#delete-a-code-scanning-analysis-from-a-repository */ "DELETE /repos/{owner}/{repo}/code-scanning/analyses/{analysis_id}{?confirm_delete}": Operation<"/repos/{owner}/{repo}/code-scanning/analyses/{analysis_id}", "delete">; + /** + * @see https://docs.github.com/rest/code-scanning/code-scanning#delete-a-codeql-database + */ + "DELETE /repos/{owner}/{repo}/code-scanning/codeql/databases/{language}": Operation<"/repos/{owner}/{repo}/code-scanning/codeql/databases/{language}", "delete">; /** * @see https://docs.github.com/rest/codespaces/repository-secrets#delete-a-repository-secret */ @@ -487,6 +515,10 @@ export interface Endpoints { * @see https://docs.github.com/rest/reactions/reactions#delete-an-issue-reaction */ "DELETE /repos/{owner}/{repo}/issues/{issue_number}/reactions/{reaction_id}": Operation<"/repos/{owner}/{repo}/issues/{issue_number}/reactions/{reaction_id}", "delete">; + /** + * @see https://docs.github.com/rest/issues/sub-issues#remove-sub-issue + */ + "DELETE /repos/{owner}/{repo}/issues/{issue_number}/sub_issue": Operation<"/repos/{owner}/{repo}/issues/{issue_number}/sub_issue", "delete">; /** * @see https://docs.github.com/rest/deploy-keys/deploy-keys#delete-a-deploy-key */ @@ -544,7 +576,7 @@ export interface Endpoints { */ "DELETE /repos/{owner}/{repo}/subscription": Operation<"/repos/{owner}/{repo}/subscription", "delete">; /** - * @see https://docs.github.com/rest/repos/tags#delete-a-tag-protection-state-for-a-repository + * @see https://docs.github.com/rest/repos/tags#closing-down---delete-a-tag-protection-state-for-a-repository */ "DELETE /repos/{owner}/{repo}/tags/protection/{tag_protection_id}": Operation<"/repos/{owner}/{repo}/tags/protection/{tag_protection_id}", "delete">; /** @@ -740,9 +772,21 @@ export interface Endpoints { */ "GET /emojis": Operation<"/emojis", "get">; /** - * @see https://docs.github.com/rest/copilot/copilot-usage#get-a-summary-of-copilot-usage-for-enterprise-members + * @see https://docs.github.com/rest/code-security/configurations#get-code-security-configurations-for-an-enterprise */ - "GET /enterprises/{enterprise}/copilot/usage": Operation<"/enterprises/{enterprise}/copilot/usage", "get">; + "GET /enterprises/{enterprise}/code-security/configurations": Operation<"/enterprises/{enterprise}/code-security/configurations", "get">; + /** + * @see https://docs.github.com/rest/code-security/configurations#get-default-code-security-configurations-for-an-enterprise + */ + "GET /enterprises/{enterprise}/code-security/configurations/defaults": Operation<"/enterprises/{enterprise}/code-security/configurations/defaults", "get">; + /** + * @see https://docs.github.com/rest/code-security/configurations#retrieve-a-code-security-configuration-of-an-enterprise + */ + "GET /enterprises/{enterprise}/code-security/configurations/{configuration_id}": Operation<"/enterprises/{enterprise}/code-security/configurations/{configuration_id}", "get">; + /** + * @see https://docs.github.com/rest/code-security/configurations#get-repositories-associated-with-an-enterprise-code-security-configuration + */ + "GET /enterprises/{enterprise}/code-security/configurations/{configuration_id}/repositories": Operation<"/enterprises/{enterprise}/code-security/configurations/{configuration_id}/repositories", "get">; /** * @see https://docs.github.com/rest/dependabot/alerts#list-dependabot-alerts-for-an-enterprise */ @@ -875,6 +919,10 @@ export interface Endpoints { * @see https://docs.github.com/rest/orgs/orgs#list-organizations */ "GET /organizations": Operation<"/organizations", "get">; + /** + * @see https://docs.github.com/rest/billing/enhanced-billing#get-billing-usage-report-for-an-organization + */ + "GET /organizations/{org}/settings/billing/usage": Operation<"/organizations/{org}/settings/billing/usage", "get">; /** * @see https://docs.github.com/rest/codespaces/organizations#list-codespaces-for-the-organization * @deprecated "org_id" is now "org" @@ -912,6 +960,22 @@ export interface Endpoints { * @see https://docs.github.com/rest/actions/permissions#get-default-workflow-permissions-for-an-organization */ "GET /orgs/{org}/actions/permissions/workflow": Operation<"/orgs/{org}/actions/permissions/workflow", "get">; + /** + * @see https://docs.github.com/rest/actions/self-hosted-runner-groups#list-self-hosted-runner-groups-for-an-organization + */ + "GET /orgs/{org}/actions/runner-groups": Operation<"/orgs/{org}/actions/runner-groups", "get">; + /** + * @see https://docs.github.com/rest/actions/self-hosted-runner-groups#get-a-self-hosted-runner-group-for-an-organization + */ + "GET /orgs/{org}/actions/runner-groups/{runner_group_id}": Operation<"/orgs/{org}/actions/runner-groups/{runner_group_id}", "get">; + /** + * @see https://docs.github.com/rest/actions/self-hosted-runner-groups#list-repository-access-to-a-self-hosted-runner-group-in-an-organization + */ + "GET /orgs/{org}/actions/runner-groups/{runner_group_id}/repositories": Operation<"/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories", "get">; + /** + * @see https://docs.github.com/rest/actions/self-hosted-runner-groups#list-self-hosted-runners-in-a-group-for-an-organization + */ + "GET /orgs/{org}/actions/runner-groups/{runner_group_id}/runners": Operation<"/orgs/{org}/actions/runner-groups/{runner_group_id}/runners", "get">; /** * @see https://docs.github.com/rest/actions/self-hosted-runners#list-self-hosted-runners-for-an-organization */ @@ -956,6 +1020,10 @@ export interface Endpoints { * @see https://docs.github.com/rest/actions/variables#list-selected-repositories-for-an-organization-variable */ "GET /orgs/{org}/actions/variables/{name}/repositories": Operation<"/orgs/{org}/actions/variables/{name}/repositories", "get">; + /** + * @see https://docs.github.com/rest/orgs/orgs#list-attestations + */ + "GET /orgs/{org}/attestations/{subject_digest}": Operation<"/orgs/{org}/attestations/{subject_digest}", "get">; /** * @see https://docs.github.com/rest/orgs/blocking#list-users-blocked-by-an-organization */ @@ -968,6 +1036,22 @@ export interface Endpoints { * @see https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-alerts-for-an-organization */ "GET /orgs/{org}/code-scanning/alerts": Operation<"/orgs/{org}/code-scanning/alerts", "get">; + /** + * @see https://docs.github.com/rest/code-security/configurations#get-code-security-configurations-for-an-organization + */ + "GET /orgs/{org}/code-security/configurations": Operation<"/orgs/{org}/code-security/configurations", "get">; + /** + * @see https://docs.github.com/rest/code-security/configurations#get-default-code-security-configurations + */ + "GET /orgs/{org}/code-security/configurations/defaults": Operation<"/orgs/{org}/code-security/configurations/defaults", "get">; + /** + * @see https://docs.github.com/rest/code-security/configurations#get-a-code-security-configuration + */ + "GET /orgs/{org}/code-security/configurations/{configuration_id}": Operation<"/orgs/{org}/code-security/configurations/{configuration_id}", "get">; + /** + * @see https://docs.github.com/rest/code-security/configurations#get-repositories-associated-with-a-code-security-configuration + */ + "GET /orgs/{org}/code-security/configurations/{configuration_id}/repositories": Operation<"/orgs/{org}/code-security/configurations/{configuration_id}/repositories", "get">; /** * @see https://docs.github.com/rest/codespaces/organizations#list-codespaces-for-the-organization */ @@ -996,6 +1080,10 @@ export interface Endpoints { * @see https://docs.github.com/rest/copilot/copilot-user-management#list-all-copilot-seat-assignments-for-an-organization */ "GET /orgs/{org}/copilot/billing/seats": Operation<"/orgs/{org}/copilot/billing/seats", "get">; + /** + * @see https://docs.github.com/rest/copilot/copilot-metrics#get-copilot-metrics-for-an-organization + */ + "GET /orgs/{org}/copilot/metrics": Operation<"/orgs/{org}/copilot/metrics", "get">; /** * @see https://docs.github.com/rest/copilot/copilot-usage#get-a-summary-of-copilot-usage-for-organization-members */ @@ -1052,6 +1140,42 @@ export interface Endpoints { * @see https://docs.github.com/rest/orgs/webhooks#get-a-webhook-delivery-for-an-organization-webhook */ "GET /orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}": Operation<"/orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}", "get">; + /** + * @see https://docs.github.com/rest/orgs/api-insights#get-route-stats-by-actor + */ + "GET /orgs/{org}/insights/api/route-stats/{actor_type}/{actor_id}": Operation<"/orgs/{org}/insights/api/route-stats/{actor_type}/{actor_id}", "get">; + /** + * @see https://docs.github.com/rest/orgs/api-insights#get-subject-stats + */ + "GET /orgs/{org}/insights/api/subject-stats": Operation<"/orgs/{org}/insights/api/subject-stats", "get">; + /** + * @see https://docs.github.com/rest/orgs/api-insights#get-summary-stats + */ + "GET /orgs/{org}/insights/api/summary-stats": Operation<"/orgs/{org}/insights/api/summary-stats", "get">; + /** + * @see https://docs.github.com/rest/orgs/api-insights#get-summary-stats-by-user + */ + "GET /orgs/{org}/insights/api/summary-stats/users/{user_id}": Operation<"/orgs/{org}/insights/api/summary-stats/users/{user_id}", "get">; + /** + * @see https://docs.github.com/rest/orgs/api-insights#get-summary-stats-by-actor + */ + "GET /orgs/{org}/insights/api/summary-stats/{actor_type}/{actor_id}": Operation<"/orgs/{org}/insights/api/summary-stats/{actor_type}/{actor_id}", "get">; + /** + * @see https://docs.github.com/rest/orgs/api-insights#get-time-stats + */ + "GET /orgs/{org}/insights/api/time-stats": Operation<"/orgs/{org}/insights/api/time-stats", "get">; + /** + * @see https://docs.github.com/rest/orgs/api-insights#get-time-stats-by-user + */ + "GET /orgs/{org}/insights/api/time-stats/users/{user_id}": Operation<"/orgs/{org}/insights/api/time-stats/users/{user_id}", "get">; + /** + * @see https://docs.github.com/rest/orgs/api-insights#get-time-stats-by-actor + */ + "GET /orgs/{org}/insights/api/time-stats/{actor_type}/{actor_id}": Operation<"/orgs/{org}/insights/api/time-stats/{actor_type}/{actor_id}", "get">; + /** + * @see https://docs.github.com/rest/orgs/api-insights#get-user-stats + */ + "GET /orgs/{org}/insights/api/user-stats/{user_id}": Operation<"/orgs/{org}/insights/api/user-stats/{user_id}", "get">; /** * @see https://docs.github.com/rest/apps/apps#get-an-organization-installation-for-the-authenticated-app */ @@ -1168,6 +1292,18 @@ export interface Endpoints { * @see https://docs.github.com/rest/orgs/personal-access-tokens#list-repositories-a-fine-grained-personal-access-token-has-access-to */ "GET /orgs/{org}/personal-access-tokens/{pat_id}/repositories": Operation<"/orgs/{org}/personal-access-tokens/{pat_id}/repositories", "get">; + /** + * @see https://docs.github.com/rest/private-registries/organization-configurations#list-private-registries-for-an-organization + */ + "GET /orgs/{org}/private-registries": Operation<"/orgs/{org}/private-registries", "get">; + /** + * @see https://docs.github.com/rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization + */ + "GET /orgs/{org}/private-registries/public-key": Operation<"/orgs/{org}/private-registries/public-key", "get">; + /** + * @see https://docs.github.com/rest/private-registries/organization-configurations#get-a-private-registry-for-an-organization + */ + "GET /orgs/{org}/private-registries/{secret_name}": Operation<"/orgs/{org}/private-registries/{secret_name}", "get">; /** * @see https://docs.github.com/rest/projects/projects#list-organization-projects */ @@ -1236,6 +1372,10 @@ export interface Endpoints { * @see https://docs.github.com/rest/billing/billing#get-shared-storage-billing-for-an-organization */ "GET /orgs/{org}/settings/billing/shared-storage": Operation<"/orgs/{org}/settings/billing/shared-storage", "get">; + /** + * @see https://docs.github.com/rest/copilot/copilot-metrics#get-copilot-metrics-for-a-team + */ + "GET /orgs/{org}/team/{team_slug}/copilot/metrics": Operation<"/orgs/{org}/team/{team_slug}/copilot/metrics", "get">; /** * @see https://docs.github.com/rest/copilot/copilot-usage#get-a-summary-of-copilot-usage-for-a-team */ @@ -1504,6 +1644,10 @@ export interface Endpoints { * @see https://docs.github.com/rest/issues/assignees#check-if-a-user-can-be-assigned */ "GET /repos/{owner}/{repo}/assignees/{assignee}": Operation<"/repos/{owner}/{repo}/assignees/{assignee}", "get">; + /** + * @see https://docs.github.com/rest/repos/repos#list-attestations + */ + "GET /repos/{owner}/{repo}/attestations/{subject_digest}": Operation<"/repos/{owner}/{repo}/attestations/{subject_digest}", "get">; /** * @see https://docs.github.com/rest/repos/autolinks#get-all-autolinks-of-a-repository */ @@ -1593,6 +1737,10 @@ export interface Endpoints { * @see https://docs.github.com/rest/code-scanning/code-scanning#get-a-code-scanning-alert */ "GET /repos/{owner}/{repo}/code-scanning/alerts/{alert_number}": Operation<"/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}", "get">; + /** + * @see https://docs.github.com/rest/code-scanning/code-scanning#get-the-status-of-an-autofix-for-a-code-scanning-alert + */ + "GET /repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/autofix": Operation<"/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/autofix", "get">; /** * @see https://docs.github.com/rest/code-scanning/code-scanning#list-instances-of-a-code-scanning-alert */ @@ -1613,6 +1761,14 @@ export interface Endpoints { * @see https://docs.github.com/rest/code-scanning/code-scanning#get-a-codeql-database-for-a-repository */ "GET /repos/{owner}/{repo}/code-scanning/codeql/databases/{language}": Operation<"/repos/{owner}/{repo}/code-scanning/codeql/databases/{language}", "get">; + /** + * @see https://docs.github.com/rest/code-scanning/code-scanning#get-the-summary-of-a-codeql-variant-analysis + */ + "GET /repos/{owner}/{repo}/code-scanning/codeql/variant-analyses/{codeql_variant_analysis_id}": Operation<"/repos/{owner}/{repo}/code-scanning/codeql/variant-analyses/{codeql_variant_analysis_id}", "get">; + /** + * @see https://docs.github.com/rest/code-scanning/code-scanning#get-the-analysis-status-of-a-repository-in-a-codeql-variant-analysis + */ + "GET /repos/{owner}/{repo}/code-scanning/codeql/variant-analyses/{codeql_variant_analysis_id}/repos/{repo_owner}/{repo_name}": Operation<"/repos/{owner}/{repo}/code-scanning/codeql/variant-analyses/{codeql_variant_analysis_id}/repos/{repo_owner}/{repo_name}", "get">; /** * @see https://docs.github.com/rest/code-scanning/code-scanning#get-a-code-scanning-default-setup-configuration */ @@ -1621,6 +1777,10 @@ export interface Endpoints { * @see https://docs.github.com/rest/code-scanning/code-scanning#get-information-about-a-sarif-upload */ "GET /repos/{owner}/{repo}/code-scanning/sarifs/{sarif_id}": Operation<"/repos/{owner}/{repo}/code-scanning/sarifs/{sarif_id}", "get">; + /** + * @see https://docs.github.com/rest/code-security/configurations#get-the-code-security-configuration-associated-with-a-repository + */ + "GET /repos/{owner}/{repo}/code-security-configuration": Operation<"/repos/{owner}/{repo}/code-security-configuration", "get">; /** * @see https://docs.github.com/rest/repos/repos#list-codeowners-errors */ @@ -1953,6 +2113,10 @@ export interface Endpoints { * @see https://docs.github.com/rest/reactions/reactions#list-reactions-for-an-issue */ "GET /repos/{owner}/{repo}/issues/{issue_number}/reactions": Operation<"/repos/{owner}/{repo}/issues/{issue_number}/reactions", "get">; + /** + * @see https://docs.github.com/rest/issues/sub-issues#list-sub-issues + */ + "GET /repos/{owner}/{repo}/issues/{issue_number}/sub_issues": Operation<"/repos/{owner}/{repo}/issues/{issue_number}/sub_issues", "get">; /** * @see https://docs.github.com/rest/issues/timeline#list-timeline-events-for-an-issue */ @@ -2153,6 +2317,10 @@ export interface Endpoints { * @see https://docs.github.com/rest/secret-scanning/secret-scanning#list-locations-for-a-secret-scanning-alert */ "GET /repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}/locations": Operation<"/repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}/locations", "get">; + /** + * @see https://docs.github.com/rest/secret-scanning/secret-scanning#get-secret-scanning-scan-history-for-a-repository + */ + "GET /repos/{owner}/{repo}/secret-scanning/scan-history": Operation<"/repos/{owner}/{repo}/secret-scanning/scan-history", "get">; /** * @see https://docs.github.com/rest/security-advisories/repository-advisories#list-repository-security-advisories */ @@ -2198,7 +2366,7 @@ export interface Endpoints { */ "GET /repos/{owner}/{repo}/tags": Operation<"/repos/{owner}/{repo}/tags", "get">; /** - * @see https://docs.github.com/rest/repos/tags#list-tag-protection-states-for-a-repository + * @see https://docs.github.com/rest/repos/tags#closing-down---list-tag-protection-states-for-a-repository */ "GET /repos/{owner}/{repo}/tags/protection": Operation<"/repos/{owner}/{repo}/tags/protection", "get">; /** @@ -2521,6 +2689,10 @@ export interface Endpoints { * @see https://docs.github.com/rest/teams/teams#list-teams-for-the-authenticated-user */ "GET /user/teams": Operation<"/user/teams", "get">; + /** + * @see https://docs.github.com/rest/users/users#get-a-user-using-their-id + */ + "GET /user/{account_id}": Operation<"/user/{account_id}", "get">; /** * @see https://docs.github.com/rest/users/users#list-users */ @@ -2529,6 +2701,10 @@ export interface Endpoints { * @see https://docs.github.com/rest/users/users#get-a-user */ "GET /users/{username}": Operation<"/users/{username}", "get">; + /** + * @see https://docs.github.com/rest/users/attestations#list-attestations + */ + "GET /users/{username}/attestations/{subject_digest}": Operation<"/users/{username}/attestations/{subject_digest}", "get">; /** * @see https://docs.github.com/rest/packages/packages#get-list-of-conflicting-packages-during-docker-migration-for-user */ @@ -2657,6 +2833,10 @@ export interface Endpoints { * @see https://docs.github.com/rest/apps/oauth-applications#reset-a-token */ "PATCH /applications/{client_id}/token": Operation<"/applications/{client_id}/token", "patch">; + /** + * @see https://docs.github.com/rest/code-security/configurations#update-a-custom-code-security-configuration-for-an-enterprise + */ + "PATCH /enterprises/{enterprise}/code-security/configurations/{configuration_id}": Operation<"/enterprises/{enterprise}/code-security/configurations/{configuration_id}", "patch">; /** * @see https://docs.github.com/rest/reference/gists/#update-a-gist */ @@ -2673,10 +2853,18 @@ export interface Endpoints { * @see https://docs.github.com/rest/orgs/orgs#update-an-organization */ "PATCH /orgs/{org}": Operation<"/orgs/{org}", "patch">; + /** + * @see https://docs.github.com/rest/actions/self-hosted-runner-groups#update-a-self-hosted-runner-group-for-an-organization + */ + "PATCH /orgs/{org}/actions/runner-groups/{runner_group_id}": Operation<"/orgs/{org}/actions/runner-groups/{runner_group_id}", "patch">; /** * @see https://docs.github.com/rest/actions/variables#update-an-organization-variable */ "PATCH /orgs/{org}/actions/variables/{name}": Operation<"/orgs/{org}/actions/variables/{name}", "patch">; + /** + * @see https://docs.github.com/rest/code-security/configurations#update-a-code-security-configuration + */ + "PATCH /orgs/{org}/code-security/configurations/{configuration_id}": Operation<"/orgs/{org}/code-security/configurations/{configuration_id}", "patch">; /** * @see https://docs.github.com/rest/orgs/webhooks#update-an-organization-webhook */ @@ -2686,9 +2874,9 @@ export interface Endpoints { */ "PATCH /orgs/{org}/hooks/{hook_id}/config": Operation<"/orgs/{org}/hooks/{hook_id}/config", "patch">; /** - * @see https://docs.github.com/rest/orgs/organization-roles#update-a-custom-organization-role + * @see https://docs.github.com/rest/private-registries/organization-configurations#update-a-private-registry-for-an-organization */ - "PATCH /orgs/{org}/organization-roles/{role_id}": Operation<"/orgs/{org}/organization-roles/{role_id}", "patch">; + "PATCH /orgs/{org}/private-registries/{secret_name}": Operation<"/orgs/{org}/private-registries/{secret_name}", "patch">; /** * @see https://docs.github.com/rest/orgs/custom-properties#create-or-update-custom-properties-for-an-organization */ @@ -2801,6 +2989,10 @@ export interface Endpoints { * @see https://docs.github.com/rest/issues/issues#update-an-issue */ "PATCH /repos/{owner}/{repo}/issues/{issue_number}": Operation<"/repos/{owner}/{repo}/issues/{issue_number}", "patch">; + /** + * @see https://docs.github.com/rest/issues/sub-issues#reprioritize-sub-issue + */ + "PATCH /repos/{owner}/{repo}/issues/{issue_number}/sub_issues/priority": Operation<"/repos/{owner}/{repo}/issues/{issue_number}/sub_issues/priority", "patch">; /** * @see https://docs.github.com/rest/issues/labels#update-a-label */ @@ -2889,6 +3081,14 @@ export interface Endpoints { * @see https://docs.github.com/rest/apps/apps#create-a-scoped-access-token */ "POST /applications/{client_id}/token/scoped": Operation<"/applications/{client_id}/token/scoped", "post">; + /** + * @see https://docs.github.com/rest/code-security/configurations#create-a-code-security-configuration-for-an-enterprise + */ + "POST /enterprises/{enterprise}/code-security/configurations": Operation<"/enterprises/{enterprise}/code-security/configurations", "post">; + /** + * @see https://docs.github.com/rest/code-security/configurations#attach-an-enterprise-configuration-to-repositories + */ + "POST /enterprises/{enterprise}/code-security/configurations/{configuration_id}/attach": Operation<"/enterprises/{enterprise}/code-security/configurations/{configuration_id}/attach", "post">; /** * @see https://docs.github.com/rest/gists/gists#create-a-gist */ @@ -2909,6 +3109,10 @@ export interface Endpoints { * @see https://docs.github.com/rest/markdown/markdown#render-a-markdown-document-in-raw-mode */ "POST /markdown/raw": Operation<"/markdown/raw", "post">; + /** + * @see https://docs.github.com/rest/actions/self-hosted-runner-groups#create-a-self-hosted-runner-group-for-an-organization + */ + "POST /orgs/{org}/actions/runner-groups": Operation<"/orgs/{org}/actions/runner-groups", "post">; /** * @see https://docs.github.com/rest/actions/self-hosted-runners#create-configuration-for-a-just-in-time-runner-for-an-organization */ @@ -2929,6 +3133,14 @@ export interface Endpoints { * @see https://docs.github.com/rest/actions/variables#create-an-organization-variable */ "POST /orgs/{org}/actions/variables": Operation<"/orgs/{org}/actions/variables", "post">; + /** + * @see https://docs.github.com/rest/code-security/configurations#create-a-code-security-configuration + */ + "POST /orgs/{org}/code-security/configurations": Operation<"/orgs/{org}/code-security/configurations", "post">; + /** + * @see https://docs.github.com/rest/code-security/configurations#attach-a-configuration-to-repositories + */ + "POST /orgs/{org}/code-security/configurations/{configuration_id}/attach": Operation<"/orgs/{org}/code-security/configurations/{configuration_id}/attach", "post">; /** * @see https://docs.github.com/rest/codespaces/organizations#add-users-to-codespaces-access-for-an-organization */ @@ -2965,10 +3177,6 @@ export interface Endpoints { * @see https://docs.github.com/rest/migrations/orgs#start-an-organization-migration */ "POST /orgs/{org}/migrations": Operation<"/orgs/{org}/migrations", "post">; - /** - * @see https://docs.github.com/rest/orgs/organization-roles#create-a-custom-organization-role - */ - "POST /orgs/{org}/organization-roles": Operation<"/orgs/{org}/organization-roles", "post">; /** * @see https://docs.github.com/rest/packages/packages#restore-a-package-for-an-organization */ @@ -2993,6 +3201,10 @@ export interface Endpoints { * @see https://docs.github.com/rest/orgs/personal-access-tokens#update-the-access-a-fine-grained-personal-access-token-has-to-organization-resources */ "POST /orgs/{org}/personal-access-tokens/{pat_id}": Operation<"/orgs/{org}/personal-access-tokens/{pat_id}", "post">; + /** + * @see https://docs.github.com/rest/private-registries/organization-configurations#create-a-private-registry-for-an-organization + */ + "POST /orgs/{org}/private-registries": Operation<"/orgs/{org}/private-registries", "post">; /** * @see https://docs.github.com/rest/projects/projects#create-an-organization-project */ @@ -3101,6 +3313,10 @@ export interface Endpoints { * @see https://docs.github.com/rest/actions/workflows#create-a-workflow-dispatch-event */ "POST /repos/{owner}/{repo}/actions/workflows/{workflow_id}/dispatches": Operation<"/repos/{owner}/{repo}/actions/workflows/{workflow_id}/dispatches", "post">; + /** + * @see https://docs.github.com/rest/repos/repos#create-an-attestation + */ + "POST /repos/{owner}/{repo}/attestations": Operation<"/repos/{owner}/{repo}/attestations", "post">; /** * @see https://docs.github.com/rest/repos/autolinks#create-an-autolink-reference-for-a-repository */ @@ -3149,6 +3365,18 @@ export interface Endpoints { * @see https://docs.github.com/rest/checks/suites#rerequest-a-check-suite */ "POST /repos/{owner}/{repo}/check-suites/{check_suite_id}/rerequest": Operation<"/repos/{owner}/{repo}/check-suites/{check_suite_id}/rerequest", "post">; + /** + * @see https://docs.github.com/rest/code-scanning/code-scanning#create-an-autofix-for-a-code-scanning-alert + */ + "POST /repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/autofix": Operation<"/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/autofix", "post">; + /** + * @see https://docs.github.com/rest/code-scanning/code-scanning#commit-an-autofix-for-a-code-scanning-alert + */ + "POST /repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/autofix/commits": Operation<"/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/autofix/commits", "post">; + /** + * @see https://docs.github.com/rest/code-scanning/code-scanning#create-a-codeql-variant-analysis + */ + "POST /repos/{owner}/{repo}/code-scanning/codeql/variant-analyses": Operation<"/repos/{owner}/{repo}/code-scanning/codeql/variant-analyses", "post">; /** * @see https://docs.github.com/rest/code-scanning/code-scanning#upload-an-analysis-as-sarif-data */ @@ -3257,6 +3485,10 @@ export interface Endpoints { * @see https://docs.github.com/rest/reactions/reactions#create-reaction-for-an-issue */ "POST /repos/{owner}/{repo}/issues/{issue_number}/reactions": Operation<"/repos/{owner}/{repo}/issues/{issue_number}/reactions", "post">; + /** + * @see https://docs.github.com/rest/issues/sub-issues#add-sub-issue + */ + "POST /repos/{owner}/{repo}/issues/{issue_number}/sub_issues": Operation<"/repos/{owner}/{repo}/issues/{issue_number}/sub_issues", "post">; /** * @see https://docs.github.com/rest/deploy-keys/deploy-keys#create-a-deploy-key */ @@ -3345,6 +3577,10 @@ export interface Endpoints { * @see https://docs.github.com/rest/repos/rules#create-a-repository-ruleset */ "POST /repos/{owner}/{repo}/rulesets": Operation<"/repos/{owner}/{repo}/rulesets", "post">; + /** + * @see https://docs.github.com/rest/secret-scanning/secret-scanning#create-a-push-protection-bypass + */ + "POST /repos/{owner}/{repo}/secret-scanning/push-protection-bypasses": Operation<"/repos/{owner}/{repo}/secret-scanning/push-protection-bypasses", "post">; /** * @see https://docs.github.com/rest/security-advisories/repository-advisories#create-a-repository-security-advisory */ @@ -3366,7 +3602,7 @@ export interface Endpoints { */ "POST /repos/{owner}/{repo}/statuses/{sha}": Operation<"/repos/{owner}/{repo}/statuses/{sha}", "post">; /** - * @see https://docs.github.com/rest/repos/tags#create-a-tag-protection-state-for-a-repository + * @see https://docs.github.com/rest/repos/tags#closing-down---create-a-tag-protection-state-for-a-repository */ "POST /repos/{owner}/{repo}/tags/protection": Operation<"/repos/{owner}/{repo}/tags/protection", "post">; /** @@ -3469,6 +3705,10 @@ export interface Endpoints { * @see https://docs.github.com/rest/apps/apps#suspend-an-app-installation */ "PUT /app/installations/{installation_id}/suspended": Operation<"/app/installations/{installation_id}/suspended", "put">; + /** + * @see https://docs.github.com/rest/code-security/configurations#set-a-code-security-configuration-as-a-default-for-an-enterprise + */ + "PUT /enterprises/{enterprise}/code-security/configurations/{configuration_id}/defaults": Operation<"/enterprises/{enterprise}/code-security/configurations/{configuration_id}/defaults", "put">; /** * @see https://docs.github.com/rest/gists/gists#star-a-gist */ @@ -3505,6 +3745,22 @@ export interface Endpoints { * @see https://docs.github.com/rest/actions/permissions#set-default-workflow-permissions-for-an-organization */ "PUT /orgs/{org}/actions/permissions/workflow": Operation<"/orgs/{org}/actions/permissions/workflow", "put">; + /** + * @see https://docs.github.com/rest/actions/self-hosted-runner-groups#set-repository-access-for-a-self-hosted-runner-group-in-an-organization + */ + "PUT /orgs/{org}/actions/runner-groups/{runner_group_id}/repositories": Operation<"/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories", "put">; + /** + * @see https://docs.github.com/rest/actions/self-hosted-runner-groups#add-repository-access-to-a-self-hosted-runner-group-in-an-organization + */ + "PUT /orgs/{org}/actions/runner-groups/{runner_group_id}/repositories/{repository_id}": Operation<"/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories/{repository_id}", "put">; + /** + * @see https://docs.github.com/rest/actions/self-hosted-runner-groups#set-self-hosted-runners-in-a-group-for-an-organization + */ + "PUT /orgs/{org}/actions/runner-groups/{runner_group_id}/runners": Operation<"/orgs/{org}/actions/runner-groups/{runner_group_id}/runners", "put">; + /** + * @see https://docs.github.com/rest/actions/self-hosted-runner-groups#add-a-self-hosted-runner-to-a-group-for-an-organization + */ + "PUT /orgs/{org}/actions/runner-groups/{runner_group_id}/runners/{runner_id}": Operation<"/orgs/{org}/actions/runner-groups/{runner_group_id}/runners/{runner_id}", "put">; /** * @see https://docs.github.com/rest/actions/self-hosted-runners#set-custom-labels-for-a-self-hosted-runner-for-an-organization */ @@ -3533,6 +3789,10 @@ export interface Endpoints { * @see https://docs.github.com/rest/orgs/blocking#block-a-user-from-an-organization */ "PUT /orgs/{org}/blocks/{username}": Operation<"/orgs/{org}/blocks/{username}", "put">; + /** + * @see https://docs.github.com/rest/code-security/configurations#set-a-code-security-configuration-as-a-default-for-an-organization + */ + "PUT /orgs/{org}/code-security/configurations/{configuration_id}/defaults": Operation<"/orgs/{org}/code-security/configurations/{configuration_id}/defaults", "put">; /** * @see https://docs.github.com/rest/codespaces/organizations#manage-access-control-for-organization-codespaces */ diff --git a/node_modules/@actions/github/node_modules/@octokit/types/package.json b/node_modules/@actions/github/node_modules/@octokit/types/package.json index 1c4494f1..b99f7a4f 100644 --- a/node_modules/@actions/github/node_modules/@octokit/types/package.json +++ b/node_modules/@actions/github/node_modules/@octokit/types/package.json @@ -1,13 +1,13 @@ { "name": "@octokit/types", - "version": "13.6.2", + "version": "13.7.0", "publishConfig": { "access": "public", "provenance": true }, "description": "Shared TypeScript definitions for Octokit projects", "dependencies": { - "@octokit/openapi-types": "^22.2.0" + "@octokit/openapi-types": "^23.0.1" }, "repository": "github:octokit/types.ts", "keywords": [ @@ -21,7 +21,7 @@ "license": "MIT", "devDependencies": { "@octokit/tsconfig": "^4.0.0", - "github-openapi-graphql-query": "^4.0.0", + "github-openapi-graphql-query": "^4.5.0", "handlebars": "^4.7.6", "npm-run-all2": "^7.0.0", "prettier": "^3.0.0", @@ -32,7 +32,7 @@ "typescript": "^5.0.0" }, "octokit": { - "openapi-version": "16.5.0" + "openapi-version": "17.1.1" }, "files": [ "dist-types/**" diff --git a/node_modules/@azure/core-rest-pipeline/dist/browser/constants.js b/node_modules/@azure/core-rest-pipeline/dist/browser/constants.js index 6374dd08..f120876f 100644 --- a/node_modules/@azure/core-rest-pipeline/dist/browser/constants.js +++ b/node_modules/@azure/core-rest-pipeline/dist/browser/constants.js @@ -1,5 +1,5 @@ // Copyright (c) Microsoft Corporation. // Licensed under the MIT License. -export const SDK_VERSION = "1.18.1"; +export const SDK_VERSION = "1.18.2"; export const DEFAULT_RETRY_POLICY_COUNT = 3; //# sourceMappingURL=constants.js.map \ No newline at end of file diff --git a/node_modules/@azure/core-rest-pipeline/dist/browser/constants.js.map b/node_modules/@azure/core-rest-pipeline/dist/browser/constants.js.map index fc8b953a..9db3903f 100644 --- a/node_modules/@azure/core-rest-pipeline/dist/browser/constants.js.map +++ b/node_modules/@azure/core-rest-pipeline/dist/browser/constants.js.map @@ -1 +1 @@ -{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../src/constants.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAElC,MAAM,CAAC,MAAM,WAAW,GAAW,QAAQ,CAAC;AAE5C,MAAM,CAAC,MAAM,0BAA0B,GAAG,CAAC,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nexport const SDK_VERSION: string = \"1.18.1\";\n\nexport const DEFAULT_RETRY_POLICY_COUNT = 3;\n"]} \ No newline at end of file +{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../src/constants.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAElC,MAAM,CAAC,MAAM,WAAW,GAAW,QAAQ,CAAC;AAE5C,MAAM,CAAC,MAAM,0BAA0B,GAAG,CAAC,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nexport const SDK_VERSION: string = \"1.18.2\";\n\nexport const DEFAULT_RETRY_POLICY_COUNT = 3;\n"]} \ No newline at end of file diff --git a/node_modules/@azure/core-rest-pipeline/dist/browser/index.d.ts.map b/node_modules/@azure/core-rest-pipeline/dist/browser/index.d.ts.map index f8bb1e79..1f8d8a55 100644 --- a/node_modules/@azure/core-rest-pipeline/dist/browser/index.d.ts.map +++ b/node_modules/@azure/core-rest-pipeline/dist/browser/index.d.ts.map @@ -1 +1 @@ -{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAIA,OAAO,CAAC,MAAM,CAAC;IACb,UAAU,QAAQ;KAAG;IACrB,UAAU,IAAI;KAAG;IACjB,UAAU,IAAI;KAAG;IACjB,UAAU,cAAc,CAAC,CAAC,GAAG,GAAG;KAAI;IACpC,UAAU,eAAe,CAAC,CAAC,GAAG,GAAG,EAAE,CAAC,GAAG,GAAG;KAAI;CAC/C;AAGD,YAAY,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AACpD,YAAY,EACV,KAAK,EACL,QAAQ,EACR,WAAW,EACX,aAAa,EACb,UAAU,EACV,WAAW,EACX,SAAS,EACT,oBAAoB,EACpB,eAAe,EACf,gBAAgB,EAChB,oBAAoB,EACpB,aAAa,EACb,SAAS,EACT,cAAc,EACd,mBAAmB,EACnB,eAAe,EACf,WAAW,EACX,WAAW,EACX,qBAAqB,GACtB,MAAM,iBAAiB,CAAC;AACzB,OAAO,EACL,KAAK,gBAAgB,IAAI,kBAAkB,EAC3C,KAAK,aAAa,EAClB,KAAK,cAAc,EACnB,KAAK,QAAQ,EACb,mBAAmB,GACpB,MAAM,eAAe,CAAC;AACvB,OAAO,EACL,yBAAyB,EACzB,KAAK,gBAAgB,EACrB,KAAK,uBAAuB,EAC5B,KAAK,eAAe,GACrB,MAAM,gCAAgC,CAAC;AACxC,OAAO,EAAE,uBAAuB,EAAE,MAAM,wBAAwB,CAAC;AACjE,OAAO,EAAE,iBAAiB,EAAE,MAAM,kBAAkB,CAAC;AACrD,OAAO,EAAE,qBAAqB,EAAE,KAAK,sBAAsB,EAAE,MAAM,sBAAsB,CAAC;AAC1F,OAAO,EAAE,SAAS,EAAE,KAAK,gBAAgB,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAC/E,OAAO,EACL,wBAAwB,EACxB,4BAA4B,GAC7B,MAAM,wCAAwC,CAAC;AAChD,OAAO,EACL,sBAAsB,EACtB,KAAK,6BAA6B,EAClC,0BAA0B,GAC3B,MAAM,sCAAsC,CAAC;AAC9C,OAAO,EACL,wBAAwB,EACxB,4BAA4B,GAC7B,MAAM,wCAAwC,CAAC;AAChD,OAAO,EAAE,SAAS,EAAE,aAAa,EAAE,KAAK,gBAAgB,EAAE,MAAM,yBAAyB,CAAC;AAC1F,OAAO,EAAE,eAAe,EAAE,mBAAmB,EAAE,MAAM,+BAA+B,CAAC;AACrF,OAAO,EAAE,WAAW,EAAE,eAAe,EAAE,uBAAuB,EAAE,MAAM,2BAA2B,CAAC;AAClG,OAAO,EACL,cAAc,EACd,kBAAkB,EAClB,KAAK,qBAAqB,GAC3B,MAAM,8BAA8B,CAAC;AACtC,OAAO,EACL,sBAAsB,EACtB,KAAK,6BAA6B,EAClC,0BAA0B,GAC3B,MAAM,sCAAsC,CAAC;AAC9C,OAAO,EACL,qBAAqB,EACrB,yBAAyB,EACzB,KAAK,4BAA4B,GAClC,MAAM,qCAAqC,CAAC;AAC7C,OAAO,EAAE,WAAW,EAAE,KAAK,kBAAkB,EAAE,MAAM,2BAA2B,CAAC;AACjF,YAAY,EACV,aAAa,EACb,gBAAgB,EAChB,cAAc,GACf,MAAM,oCAAoC,CAAC;AAC5C,OAAO,EACL,aAAa,EACb,iBAAiB,EACjB,KAAK,oBAAoB,GAC1B,MAAM,6BAA6B,CAAC;AACrC,OAAO,EACL,kBAAkB,EAClB,KAAK,yBAAyB,GAC/B,MAAM,kCAAkC,CAAC;AAC1C,OAAO,EACL,eAAe,EACf,mBAAmB,EACnB,KAAK,sBAAsB,GAC5B,MAAM,+BAA+B,CAAC;AACvC,OAAO,EAAE,SAAS,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAC;AACnE,OAAO,EAAE,cAAc,EAAE,kBAAkB,EAAE,MAAM,8BAA8B,CAAC;AAClF,OAAO,EACL,+BAA+B,EAC/B,KAAK,sCAAsC,EAC3C,mCAAmC,EACnC,KAAK,kBAAkB,EACvB,KAAK,uBAAuB,EAC5B,KAAK,kCAAkC,GACxC,MAAM,+CAA+C,CAAC;AACvD,OAAO,EAAE,YAAY,EAAE,gBAAgB,EAAE,MAAM,4BAA4B,CAAC;AAC5E,OAAO,EACL,mCAAmC,EACnC,KAAK,0CAA0C,EAC/C,uCAAuC,GACxC,MAAM,mDAAmD,CAAC;AAC3D,OAAO,EACL,UAAU,EACV,oBAAoB,EACpB,KAAK,iBAAiB,EACtB,KAAK,2BAA2B,GACjC,MAAM,gBAAgB,CAAC"} \ No newline at end of file +{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAGA,OAAO,CAAC,MAAM,CAAC;IACb,UAAU,QAAQ;KAAG;IACrB,UAAU,IAAI;KAAG;IACjB,UAAU,IAAI;KAAG;IACjB,UAAU,cAAc,CAAC,CAAC,GAAG,GAAG;KAAI;IACpC,UAAU,eAAe,CAAC,CAAC,GAAG,GAAG,EAAE,CAAC,GAAG,GAAG;KAAI;CAC/C;AAED,YAAY,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AACpD,YAAY,EACV,KAAK,EACL,QAAQ,EACR,WAAW,EACX,aAAa,EACb,UAAU,EACV,WAAW,EACX,SAAS,EACT,oBAAoB,EACpB,eAAe,EACf,gBAAgB,EAChB,oBAAoB,EACpB,aAAa,EACb,SAAS,EACT,cAAc,EACd,mBAAmB,EACnB,eAAe,EACf,WAAW,EACX,WAAW,EACX,qBAAqB,GACtB,MAAM,iBAAiB,CAAC;AACzB,OAAO,EACL,KAAK,gBAAgB,IAAI,kBAAkB,EAC3C,KAAK,aAAa,EAClB,KAAK,cAAc,EACnB,KAAK,QAAQ,EACb,mBAAmB,GACpB,MAAM,eAAe,CAAC;AACvB,OAAO,EACL,yBAAyB,EACzB,KAAK,gBAAgB,EACrB,KAAK,uBAAuB,EAC5B,KAAK,eAAe,GACrB,MAAM,gCAAgC,CAAC;AACxC,OAAO,EAAE,uBAAuB,EAAE,MAAM,wBAAwB,CAAC;AACjE,OAAO,EAAE,iBAAiB,EAAE,MAAM,kBAAkB,CAAC;AACrD,OAAO,EAAE,qBAAqB,EAAE,KAAK,sBAAsB,EAAE,MAAM,sBAAsB,CAAC;AAC1F,OAAO,EAAE,SAAS,EAAE,KAAK,gBAAgB,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAC/E,OAAO,EACL,wBAAwB,EACxB,4BAA4B,GAC7B,MAAM,wCAAwC,CAAC;AAChD,OAAO,EACL,sBAAsB,EACtB,KAAK,6BAA6B,EAClC,0BAA0B,GAC3B,MAAM,sCAAsC,CAAC;AAC9C,OAAO,EACL,wBAAwB,EACxB,4BAA4B,GAC7B,MAAM,wCAAwC,CAAC;AAChD,OAAO,EAAE,SAAS,EAAE,aAAa,EAAE,KAAK,gBAAgB,EAAE,MAAM,yBAAyB,CAAC;AAC1F,OAAO,EAAE,eAAe,EAAE,mBAAmB,EAAE,MAAM,+BAA+B,CAAC;AACrF,OAAO,EAAE,WAAW,EAAE,eAAe,EAAE,uBAAuB,EAAE,MAAM,2BAA2B,CAAC;AAClG,OAAO,EACL,cAAc,EACd,kBAAkB,EAClB,KAAK,qBAAqB,GAC3B,MAAM,8BAA8B,CAAC;AACtC,OAAO,EACL,sBAAsB,EACtB,KAAK,6BAA6B,EAClC,0BAA0B,GAC3B,MAAM,sCAAsC,CAAC;AAC9C,OAAO,EACL,qBAAqB,EACrB,yBAAyB,EACzB,KAAK,4BAA4B,GAClC,MAAM,qCAAqC,CAAC;AAC7C,OAAO,EAAE,WAAW,EAAE,KAAK,kBAAkB,EAAE,MAAM,2BAA2B,CAAC;AACjF,YAAY,EACV,aAAa,EACb,gBAAgB,EAChB,cAAc,GACf,MAAM,oCAAoC,CAAC;AAC5C,OAAO,EACL,aAAa,EACb,iBAAiB,EACjB,KAAK,oBAAoB,GAC1B,MAAM,6BAA6B,CAAC;AACrC,OAAO,EACL,kBAAkB,EAClB,KAAK,yBAAyB,GAC/B,MAAM,kCAAkC,CAAC;AAC1C,OAAO,EACL,eAAe,EACf,mBAAmB,EACnB,KAAK,sBAAsB,GAC5B,MAAM,+BAA+B,CAAC;AACvC,OAAO,EAAE,SAAS,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAC;AACnE,OAAO,EAAE,cAAc,EAAE,kBAAkB,EAAE,MAAM,8BAA8B,CAAC;AAClF,OAAO,EACL,+BAA+B,EAC/B,KAAK,sCAAsC,EAC3C,mCAAmC,EACnC,KAAK,kBAAkB,EACvB,KAAK,uBAAuB,EAC5B,KAAK,kCAAkC,GACxC,MAAM,+CAA+C,CAAC;AACvD,OAAO,EAAE,YAAY,EAAE,gBAAgB,EAAE,MAAM,4BAA4B,CAAC;AAC5E,OAAO,EACL,mCAAmC,EACnC,KAAK,0CAA0C,EAC/C,uCAAuC,GACxC,MAAM,mDAAmD,CAAC;AAC3D,OAAO,EACL,UAAU,EACV,oBAAoB,EACpB,KAAK,iBAAiB,EACtB,KAAK,2BAA2B,GACjC,MAAM,gBAAgB,CAAC"} \ No newline at end of file diff --git a/node_modules/@azure/core-rest-pipeline/dist/browser/index.js.map b/node_modules/@azure/core-rest-pipeline/dist/browser/index.js.map index 52b04661..b19f3381 100644 --- a/node_modules/@azure/core-rest-pipeline/dist/browser/index.js.map +++ b/node_modules/@azure/core-rest-pipeline/dist/browser/index.js.map @@ -1 +1 @@ -{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAkClC,OAAO,EAKL,mBAAmB,GACpB,MAAM,eAAe,CAAC;AACvB,OAAO,EACL,yBAAyB,GAI1B,MAAM,gCAAgC,CAAC;AACxC,OAAO,EAAE,uBAAuB,EAAE,MAAM,wBAAwB,CAAC;AACjE,OAAO,EAAE,iBAAiB,EAAE,MAAM,kBAAkB,CAAC;AACrD,OAAO,EAAE,qBAAqB,EAA+B,MAAM,sBAAsB,CAAC;AAC1F,OAAO,EAAE,SAAS,EAAyB,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAC/E,OAAO,EACL,wBAAwB,EACxB,4BAA4B,GAC7B,MAAM,wCAAwC,CAAC;AAChD,OAAO,EACL,sBAAsB,EAEtB,0BAA0B,GAC3B,MAAM,sCAAsC,CAAC;AAC9C,OAAO,EACL,wBAAwB,EACxB,4BAA4B,GAC7B,MAAM,wCAAwC,CAAC;AAChD,OAAO,EAAE,SAAS,EAAE,aAAa,EAAyB,MAAM,yBAAyB,CAAC;AAC1F,OAAO,EAAE,eAAe,EAAE,mBAAmB,EAAE,MAAM,+BAA+B,CAAC;AACrF,OAAO,EAAE,WAAW,EAAE,eAAe,EAAE,uBAAuB,EAAE,MAAM,2BAA2B,CAAC;AAClG,OAAO,EACL,cAAc,EACd,kBAAkB,GAEnB,MAAM,8BAA8B,CAAC;AACtC,OAAO,EACL,sBAAsB,EAEtB,0BAA0B,GAC3B,MAAM,sCAAsC,CAAC;AAC9C,OAAO,EACL,qBAAqB,EACrB,yBAAyB,GAE1B,MAAM,qCAAqC,CAAC;AAC7C,OAAO,EAAE,WAAW,EAA2B,MAAM,2BAA2B,CAAC;AAMjF,OAAO,EACL,aAAa,EACb,iBAAiB,GAElB,MAAM,6BAA6B,CAAC;AACrC,OAAO,EACL,kBAAkB,GAEnB,MAAM,kCAAkC,CAAC;AAC1C,OAAO,EACL,eAAe,EACf,mBAAmB,GAEpB,MAAM,+BAA+B,CAAC;AACvC,OAAO,EAAE,SAAS,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAC;AACnE,OAAO,EAAE,cAAc,EAAE,kBAAkB,EAAE,MAAM,8BAA8B,CAAC;AAClF,OAAO,EACL,+BAA+B,EAE/B,mCAAmC,GAIpC,MAAM,+CAA+C,CAAC;AACvD,OAAO,EAAE,YAAY,EAAE,gBAAgB,EAAE,MAAM,4BAA4B,CAAC;AAC5E,OAAO,EACL,mCAAmC,EAEnC,uCAAuC,GACxC,MAAM,mDAAmD,CAAC;AAC3D,OAAO,EACL,UAAU,EACV,oBAAoB,GAGrB,MAAM,gBAAgB,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\n/* eslint-disable @typescript-eslint/no-unused-vars */\ndeclare global {\n interface FormData {}\n interface Blob {}\n interface File {}\n interface ReadableStream {}\n interface TransformStream {}\n}\n\n/* eslint-enable @typescript-eslint/no-unused-vars */\nexport type { HttpMethods } from \"@azure/core-util\";\nexport type {\n Agent,\n BodyPart,\n FormDataMap,\n FormDataValue,\n HttpClient,\n HttpHeaders,\n KeyObject,\n MultipartRequestBody,\n PipelineRequest,\n PipelineResponse,\n PipelineRetryOptions,\n ProxySettings,\n PxfObject,\n RawHttpHeaders,\n RawHttpHeadersInput,\n RequestBodyType,\n SendRequest,\n TlsSettings,\n TransferProgressEvent,\n} from \"./interfaces.js\";\nexport {\n type AddPolicyOptions as AddPipelineOptions,\n type PipelinePhase,\n type PipelinePolicy,\n type Pipeline,\n createEmptyPipeline,\n} from \"./pipeline.js\";\nexport {\n createPipelineFromOptions,\n type TelemetryOptions,\n type InternalPipelineOptions,\n type PipelineOptions,\n} from \"./createPipelineFromOptions.js\";\nexport { createDefaultHttpClient } from \"./defaultHttpClient.js\";\nexport { createHttpHeaders } from \"./httpHeaders.js\";\nexport { createPipelineRequest, type PipelineRequestOptions } from \"./pipelineRequest.js\";\nexport { RestError, type RestErrorOptions, isRestError } from \"./restError.js\";\nexport {\n decompressResponsePolicy,\n decompressResponsePolicyName,\n} from \"./policies/decompressResponsePolicy.js\";\nexport {\n exponentialRetryPolicy,\n type ExponentialRetryPolicyOptions,\n exponentialRetryPolicyName,\n} from \"./policies/exponentialRetryPolicy.js\";\nexport {\n setClientRequestIdPolicy,\n setClientRequestIdPolicyName,\n} from \"./policies/setClientRequestIdPolicy.js\";\nexport { logPolicy, logPolicyName, type LogPolicyOptions } from \"./policies/logPolicy.js\";\nexport { multipartPolicy, multipartPolicyName } from \"./policies/multipartPolicy.js\";\nexport { proxyPolicy, proxyPolicyName, getDefaultProxySettings } from \"./policies/proxyPolicy.js\";\nexport {\n redirectPolicy,\n redirectPolicyName,\n type RedirectPolicyOptions,\n} from \"./policies/redirectPolicy.js\";\nexport {\n systemErrorRetryPolicy,\n type SystemErrorRetryPolicyOptions,\n systemErrorRetryPolicyName,\n} from \"./policies/systemErrorRetryPolicy.js\";\nexport {\n throttlingRetryPolicy,\n throttlingRetryPolicyName,\n type ThrottlingRetryPolicyOptions,\n} from \"./policies/throttlingRetryPolicy.js\";\nexport { retryPolicy, type RetryPolicyOptions } from \"./policies/retryPolicy.js\";\nexport type {\n RetryStrategy,\n RetryInformation,\n RetryModifiers,\n} from \"./retryStrategies/retryStrategy.js\";\nexport {\n tracingPolicy,\n tracingPolicyName,\n type TracingPolicyOptions,\n} from \"./policies/tracingPolicy.js\";\nexport {\n defaultRetryPolicy,\n type DefaultRetryPolicyOptions,\n} from \"./policies/defaultRetryPolicy.js\";\nexport {\n userAgentPolicy,\n userAgentPolicyName,\n type UserAgentPolicyOptions,\n} from \"./policies/userAgentPolicy.js\";\nexport { tlsPolicy, tlsPolicyName } from \"./policies/tlsPolicy.js\";\nexport { formDataPolicy, formDataPolicyName } from \"./policies/formDataPolicy.js\";\nexport {\n bearerTokenAuthenticationPolicy,\n type BearerTokenAuthenticationPolicyOptions,\n bearerTokenAuthenticationPolicyName,\n type ChallengeCallbacks,\n type AuthorizeRequestOptions,\n type AuthorizeRequestOnChallengeOptions,\n} from \"./policies/bearerTokenAuthenticationPolicy.js\";\nexport { ndJsonPolicy, ndJsonPolicyName } from \"./policies/ndJsonPolicy.js\";\nexport {\n auxiliaryAuthenticationHeaderPolicy,\n type AuxiliaryAuthenticationHeaderPolicyOptions,\n auxiliaryAuthenticationHeaderPolicyName,\n} from \"./policies/auxiliaryAuthenticationHeaderPolicy.js\";\nexport {\n createFile,\n createFileFromStream,\n type CreateFileOptions,\n type CreateFileFromStreamOptions,\n} from \"./util/file.js\";\n"]} \ No newline at end of file +{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAgClC,OAAO,EAKL,mBAAmB,GACpB,MAAM,eAAe,CAAC;AACvB,OAAO,EACL,yBAAyB,GAI1B,MAAM,gCAAgC,CAAC;AACxC,OAAO,EAAE,uBAAuB,EAAE,MAAM,wBAAwB,CAAC;AACjE,OAAO,EAAE,iBAAiB,EAAE,MAAM,kBAAkB,CAAC;AACrD,OAAO,EAAE,qBAAqB,EAA+B,MAAM,sBAAsB,CAAC;AAC1F,OAAO,EAAE,SAAS,EAAyB,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAC/E,OAAO,EACL,wBAAwB,EACxB,4BAA4B,GAC7B,MAAM,wCAAwC,CAAC;AAChD,OAAO,EACL,sBAAsB,EAEtB,0BAA0B,GAC3B,MAAM,sCAAsC,CAAC;AAC9C,OAAO,EACL,wBAAwB,EACxB,4BAA4B,GAC7B,MAAM,wCAAwC,CAAC;AAChD,OAAO,EAAE,SAAS,EAAE,aAAa,EAAyB,MAAM,yBAAyB,CAAC;AAC1F,OAAO,EAAE,eAAe,EAAE,mBAAmB,EAAE,MAAM,+BAA+B,CAAC;AACrF,OAAO,EAAE,WAAW,EAAE,eAAe,EAAE,uBAAuB,EAAE,MAAM,2BAA2B,CAAC;AAClG,OAAO,EACL,cAAc,EACd,kBAAkB,GAEnB,MAAM,8BAA8B,CAAC;AACtC,OAAO,EACL,sBAAsB,EAEtB,0BAA0B,GAC3B,MAAM,sCAAsC,CAAC;AAC9C,OAAO,EACL,qBAAqB,EACrB,yBAAyB,GAE1B,MAAM,qCAAqC,CAAC;AAC7C,OAAO,EAAE,WAAW,EAA2B,MAAM,2BAA2B,CAAC;AAMjF,OAAO,EACL,aAAa,EACb,iBAAiB,GAElB,MAAM,6BAA6B,CAAC;AACrC,OAAO,EACL,kBAAkB,GAEnB,MAAM,kCAAkC,CAAC;AAC1C,OAAO,EACL,eAAe,EACf,mBAAmB,GAEpB,MAAM,+BAA+B,CAAC;AACvC,OAAO,EAAE,SAAS,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAC;AACnE,OAAO,EAAE,cAAc,EAAE,kBAAkB,EAAE,MAAM,8BAA8B,CAAC;AAClF,OAAO,EACL,+BAA+B,EAE/B,mCAAmC,GAIpC,MAAM,+CAA+C,CAAC;AACvD,OAAO,EAAE,YAAY,EAAE,gBAAgB,EAAE,MAAM,4BAA4B,CAAC;AAC5E,OAAO,EACL,mCAAmC,EAEnC,uCAAuC,GACxC,MAAM,mDAAmD,CAAC;AAC3D,OAAO,EACL,UAAU,EACV,oBAAoB,GAGrB,MAAM,gBAAgB,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\ndeclare global {\n interface FormData {}\n interface Blob {}\n interface File {}\n interface ReadableStream {}\n interface TransformStream {}\n}\n\nexport type { HttpMethods } from \"@azure/core-util\";\nexport type {\n Agent,\n BodyPart,\n FormDataMap,\n FormDataValue,\n HttpClient,\n HttpHeaders,\n KeyObject,\n MultipartRequestBody,\n PipelineRequest,\n PipelineResponse,\n PipelineRetryOptions,\n ProxySettings,\n PxfObject,\n RawHttpHeaders,\n RawHttpHeadersInput,\n RequestBodyType,\n SendRequest,\n TlsSettings,\n TransferProgressEvent,\n} from \"./interfaces.js\";\nexport {\n type AddPolicyOptions as AddPipelineOptions,\n type PipelinePhase,\n type PipelinePolicy,\n type Pipeline,\n createEmptyPipeline,\n} from \"./pipeline.js\";\nexport {\n createPipelineFromOptions,\n type TelemetryOptions,\n type InternalPipelineOptions,\n type PipelineOptions,\n} from \"./createPipelineFromOptions.js\";\nexport { createDefaultHttpClient } from \"./defaultHttpClient.js\";\nexport { createHttpHeaders } from \"./httpHeaders.js\";\nexport { createPipelineRequest, type PipelineRequestOptions } from \"./pipelineRequest.js\";\nexport { RestError, type RestErrorOptions, isRestError } from \"./restError.js\";\nexport {\n decompressResponsePolicy,\n decompressResponsePolicyName,\n} from \"./policies/decompressResponsePolicy.js\";\nexport {\n exponentialRetryPolicy,\n type ExponentialRetryPolicyOptions,\n exponentialRetryPolicyName,\n} from \"./policies/exponentialRetryPolicy.js\";\nexport {\n setClientRequestIdPolicy,\n setClientRequestIdPolicyName,\n} from \"./policies/setClientRequestIdPolicy.js\";\nexport { logPolicy, logPolicyName, type LogPolicyOptions } from \"./policies/logPolicy.js\";\nexport { multipartPolicy, multipartPolicyName } from \"./policies/multipartPolicy.js\";\nexport { proxyPolicy, proxyPolicyName, getDefaultProxySettings } from \"./policies/proxyPolicy.js\";\nexport {\n redirectPolicy,\n redirectPolicyName,\n type RedirectPolicyOptions,\n} from \"./policies/redirectPolicy.js\";\nexport {\n systemErrorRetryPolicy,\n type SystemErrorRetryPolicyOptions,\n systemErrorRetryPolicyName,\n} from \"./policies/systemErrorRetryPolicy.js\";\nexport {\n throttlingRetryPolicy,\n throttlingRetryPolicyName,\n type ThrottlingRetryPolicyOptions,\n} from \"./policies/throttlingRetryPolicy.js\";\nexport { retryPolicy, type RetryPolicyOptions } from \"./policies/retryPolicy.js\";\nexport type {\n RetryStrategy,\n RetryInformation,\n RetryModifiers,\n} from \"./retryStrategies/retryStrategy.js\";\nexport {\n tracingPolicy,\n tracingPolicyName,\n type TracingPolicyOptions,\n} from \"./policies/tracingPolicy.js\";\nexport {\n defaultRetryPolicy,\n type DefaultRetryPolicyOptions,\n} from \"./policies/defaultRetryPolicy.js\";\nexport {\n userAgentPolicy,\n userAgentPolicyName,\n type UserAgentPolicyOptions,\n} from \"./policies/userAgentPolicy.js\";\nexport { tlsPolicy, tlsPolicyName } from \"./policies/tlsPolicy.js\";\nexport { formDataPolicy, formDataPolicyName } from \"./policies/formDataPolicy.js\";\nexport {\n bearerTokenAuthenticationPolicy,\n type BearerTokenAuthenticationPolicyOptions,\n bearerTokenAuthenticationPolicyName,\n type ChallengeCallbacks,\n type AuthorizeRequestOptions,\n type AuthorizeRequestOnChallengeOptions,\n} from \"./policies/bearerTokenAuthenticationPolicy.js\";\nexport { ndJsonPolicy, ndJsonPolicyName } from \"./policies/ndJsonPolicy.js\";\nexport {\n auxiliaryAuthenticationHeaderPolicy,\n type AuxiliaryAuthenticationHeaderPolicyOptions,\n auxiliaryAuthenticationHeaderPolicyName,\n} from \"./policies/auxiliaryAuthenticationHeaderPolicy.js\";\nexport {\n createFile,\n createFileFromStream,\n type CreateFileOptions,\n type CreateFileFromStreamOptions,\n} from \"./util/file.js\";\n"]} \ No newline at end of file diff --git a/node_modules/@azure/core-rest-pipeline/dist/browser/policies/retryPolicy.d.ts.map b/node_modules/@azure/core-rest-pipeline/dist/browser/policies/retryPolicy.d.ts.map index d4afad3b..a94ed48e 100644 --- a/node_modules/@azure/core-rest-pipeline/dist/browser/policies/retryPolicy.d.ts.map +++ b/node_modules/@azure/core-rest-pipeline/dist/browser/policies/retryPolicy.d.ts.map @@ -1 +1 @@ -{"version":3,"file":"retryPolicy.d.ts","sourceRoot":"","sources":["../../../src/policies/retryPolicy.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAErD,OAAO,EAAE,KAAK,WAAW,EAAsB,MAAM,eAAe,CAAC;AACrE,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,qCAAqC,CAAC;AAYzE;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,MAAM,CAAC,EAAE,WAAW,CAAC;CACtB;AAED;;GAEG;AACH,wBAAgB,WAAW,CACzB,UAAU,EAAE,aAAa,EAAE,EAC3B,OAAO,GAAE,kBAA+D,GACvE,cAAc,CAmHhB"} \ No newline at end of file +{"version":3,"file":"retryPolicy.d.ts","sourceRoot":"","sources":["../../../src/policies/retryPolicy.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAErD,OAAO,EAAE,KAAK,WAAW,EAAsB,MAAM,eAAe,CAAC;AACrE,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,qCAAqC,CAAC;AAYzE;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,MAAM,CAAC,EAAE,WAAW,CAAC;CACtB;AAED;;GAEG;AACH,wBAAgB,WAAW,CACzB,UAAU,EAAE,aAAa,EAAE,EAC3B,OAAO,GAAE,kBAA+D,GACvE,cAAc,CAkHhB"} \ No newline at end of file diff --git a/node_modules/@azure/core-rest-pipeline/dist/browser/policies/retryPolicy.js b/node_modules/@azure/core-rest-pipeline/dist/browser/policies/retryPolicy.js index 9629aa29..7c16db75 100644 --- a/node_modules/@azure/core-rest-pipeline/dist/browser/policies/retryPolicy.js +++ b/node_modules/@azure/core-rest-pipeline/dist/browser/policies/retryPolicy.js @@ -21,7 +21,6 @@ export function retryPolicy(strategies, options = { maxRetries: DEFAULT_RETRY_PO let response; let responseError; let retryCount = -1; - // eslint-disable-next-line no-constant-condition retryRequest: while (true) { retryCount += 1; response = undefined; diff --git a/node_modules/@azure/core-rest-pipeline/dist/browser/policies/retryPolicy.js.map b/node_modules/@azure/core-rest-pipeline/dist/browser/policies/retryPolicy.js.map index 04b1b73d..51ba69b8 100644 --- a/node_modules/@azure/core-rest-pipeline/dist/browser/policies/retryPolicy.js.map +++ b/node_modules/@azure/core-rest-pipeline/dist/browser/policies/retryPolicy.js.map @@ -1 +1 @@ -{"version":3,"file":"retryPolicy.js","sourceRoot":"","sources":["../../../src/policies/retryPolicy.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAIlC,OAAO,EAAE,KAAK,EAAE,MAAM,oBAAoB,CAAC;AAC3C,OAAO,EAAoB,kBAAkB,EAAE,MAAM,eAAe,CAAC;AAGrE,OAAO,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAC;AACrD,OAAO,EAAE,0BAA0B,EAAE,MAAM,iBAAiB,CAAC;AAE7D,MAAM,iBAAiB,GAAG,kBAAkB,CAAC,gCAAgC,CAAC,CAAC;AAE/E;;GAEG;AACH,MAAM,eAAe,GAAG,aAAa,CAAC;AAgBtC;;GAEG;AACH,MAAM,UAAU,WAAW,CACzB,UAA2B,EAC3B,UAA8B,EAAE,UAAU,EAAE,0BAA0B,EAAE;IAExE,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,IAAI,iBAAiB,CAAC;IACnD,OAAO;QACL,IAAI,EAAE,eAAe;QACrB,KAAK,CAAC,WAAW,CAAC,OAAwB,EAAE,IAAiB;;YAC3D,IAAI,QAAsC,CAAC;YAC3C,IAAI,aAAoC,CAAC;YACzC,IAAI,UAAU,GAAG,CAAC,CAAC,CAAC;YAEpB,iDAAiD;YACjD,YAAY,EAAE,OAAO,IAAI,EAAE,CAAC;gBAC1B,UAAU,IAAI,CAAC,CAAC;gBAChB,QAAQ,GAAG,SAAS,CAAC;gBACrB,aAAa,GAAG,SAAS,CAAC;gBAE1B,IAAI,CAAC;oBACH,MAAM,CAAC,IAAI,CAAC,SAAS,UAAU,8BAA8B,EAAE,OAAO,CAAC,SAAS,CAAC,CAAC;oBAClF,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,CAAC;oBAC/B,MAAM,CAAC,IAAI,CAAC,SAAS,UAAU,oCAAoC,EAAE,OAAO,CAAC,SAAS,CAAC,CAAC;gBAC1F,CAAC;gBAAC,OAAO,CAAM,EAAE,CAAC;oBAChB,MAAM,CAAC,KAAK,CAAC,SAAS,UAAU,kCAAkC,EAAE,OAAO,CAAC,SAAS,CAAC,CAAC;oBAEvF,yDAAyD;oBACzD,gGAAgG;oBAChG,sEAAsE;oBACtE,aAAa,GAAG,CAAc,CAAC;oBAC/B,IAAI,CAAC,CAAC,IAAI,aAAa,CAAC,IAAI,KAAK,WAAW,EAAE,CAAC;wBAC7C,MAAM,CAAC,CAAC;oBACV,CAAC;oBAED,QAAQ,GAAG,aAAa,CAAC,QAAQ,CAAC;gBACpC,CAAC;gBAED,IAAI,MAAA,OAAO,CAAC,WAAW,0CAAE,OAAO,EAAE,CAAC;oBACjC,MAAM,CAAC,KAAK,CAAC,SAAS,UAAU,oBAAoB,CAAC,CAAC;oBACtD,MAAM,UAAU,GAAG,IAAI,UAAU,EAAE,CAAC;oBACpC,MAAM,UAAU,CAAC;gBACnB,CAAC;gBAED,IAAI,UAAU,IAAI,CAAC,MAAA,OAAO,CAAC,UAAU,mCAAI,0BAA0B,CAAC,EAAE,CAAC;oBACrE,MAAM,CAAC,IAAI,CACT,SAAS,UAAU,uGAAuG,CAC3H,CAAC;oBACF,IAAI,aAAa,EAAE,CAAC;wBAClB,MAAM,aAAa,CAAC;oBACtB,CAAC;yBAAM,IAAI,QAAQ,EAAE,CAAC;wBACpB,OAAO,QAAQ,CAAC;oBAClB,CAAC;yBAAM,CAAC;wBACN,MAAM,IAAI,KAAK,CAAC,4DAA4D,CAAC,CAAC;oBAChF,CAAC;gBACH,CAAC;gBAED,MAAM,CAAC,IAAI,CAAC,SAAS,UAAU,gBAAgB,UAAU,CAAC,MAAM,oBAAoB,CAAC,CAAC;gBAEtF,cAAc,EAAE,KAAK,MAAM,QAAQ,IAAI,UAAU,EAAE,CAAC;oBAClD,MAAM,cAAc,GAAG,QAAQ,CAAC,MAAM,IAAI,iBAAiB,CAAC;oBAC5D,cAAc,CAAC,IAAI,CAAC,SAAS,UAAU,+BAA+B,QAAQ,CAAC,IAAI,GAAG,CAAC,CAAC;oBAExF,MAAM,SAAS,GAAG,QAAQ,CAAC,KAAK,CAAC;wBAC/B,UAAU;wBACV,QAAQ;wBACR,aAAa;qBACd,CAAC,CAAC;oBAEH,IAAI,SAAS,CAAC,YAAY,EAAE,CAAC;wBAC3B,cAAc,CAAC,IAAI,CAAC,SAAS,UAAU,YAAY,CAAC,CAAC;wBACrD,SAAS,cAAc,CAAC;oBAC1B,CAAC;oBAED,MAAM,EAAE,YAAY,EAAE,cAAc,EAAE,UAAU,EAAE,GAAG,SAAS,CAAC;oBAE/D,IAAI,YAAY,EAAE,CAAC;wBACjB,cAAc,CAAC,KAAK,CAClB,SAAS,UAAU,oBAAoB,QAAQ,CAAC,IAAI,gBAAgB,EACpE,YAAY,CACb,CAAC;wBACF,MAAM,YAAY,CAAC;oBACrB,CAAC;oBAED,IAAI,cAAc,IAAI,cAAc,KAAK,CAAC,EAAE,CAAC;wBAC3C,cAAc,CAAC,IAAI,CACjB,SAAS,UAAU,oBAAoB,QAAQ,CAAC,IAAI,kBAAkB,cAAc,EAAE,CACvF,CAAC;wBACF,MAAM,KAAK,CAAC,cAAc,EAAE,SAAS,EAAE,EAAE,WAAW,EAAE,OAAO,CAAC,WAAW,EAAE,CAAC,CAAC;wBAC7E,SAAS,YAAY,CAAC;oBACxB,CAAC;oBAED,IAAI,UAAU,EAAE,CAAC;wBACf,cAAc,CAAC,IAAI,CACjB,SAAS,UAAU,oBAAoB,QAAQ,CAAC,IAAI,iBAAiB,UAAU,EAAE,CAClF,CAAC;wBACF,OAAO,CAAC,GAAG,GAAG,UAAU,CAAC;wBACzB,SAAS,YAAY,CAAC;oBACxB,CAAC;gBACH,CAAC;gBAED,IAAI,aAAa,EAAE,CAAC;oBAClB,MAAM,CAAC,IAAI,CACT,+EAA+E,CAChF,CAAC;oBACF,MAAM,aAAa,CAAC;gBACtB,CAAC;gBACD,IAAI,QAAQ,EAAE,CAAC;oBACb,MAAM,CAAC,IAAI,CACT,mFAAmF,CACpF,CAAC;oBACF,OAAO,QAAQ,CAAC;gBAClB,CAAC;gBAED,mDAAmD;gBACnD,+DAA+D;gBAC/D,iCAAiC;YACnC,CAAC;QACH,CAAC;KACF,CAAC;AACJ,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport type { PipelineRequest, PipelineResponse, SendRequest } from \"../interfaces.js\";\nimport type { PipelinePolicy } from \"../pipeline.js\";\nimport { delay } from \"../util/helpers.js\";\nimport { type AzureLogger, createClientLogger } from \"@azure/logger\";\nimport type { RetryStrategy } from \"../retryStrategies/retryStrategy.js\";\nimport type { RestError } from \"../restError.js\";\nimport { AbortError } from \"@azure/abort-controller\";\nimport { DEFAULT_RETRY_POLICY_COUNT } from \"../constants.js\";\n\nconst retryPolicyLogger = createClientLogger(\"core-rest-pipeline retryPolicy\");\n\n/**\n * The programmatic identifier of the retryPolicy.\n */\nconst retryPolicyName = \"retryPolicy\";\n\n/**\n * Options to the {@link retryPolicy}\n */\nexport interface RetryPolicyOptions {\n /**\n * Maximum number of retries. If not specified, it will limit to 3 retries.\n */\n maxRetries?: number;\n /**\n * Logger. If it's not provided, a default logger is used.\n */\n logger?: AzureLogger;\n}\n\n/**\n * retryPolicy is a generic policy to enable retrying requests when certain conditions are met\n */\nexport function retryPolicy(\n strategies: RetryStrategy[],\n options: RetryPolicyOptions = { maxRetries: DEFAULT_RETRY_POLICY_COUNT },\n): PipelinePolicy {\n const logger = options.logger || retryPolicyLogger;\n return {\n name: retryPolicyName,\n async sendRequest(request: PipelineRequest, next: SendRequest): Promise {\n let response: PipelineResponse | undefined;\n let responseError: RestError | undefined;\n let retryCount = -1;\n\n // eslint-disable-next-line no-constant-condition\n retryRequest: while (true) {\n retryCount += 1;\n response = undefined;\n responseError = undefined;\n\n try {\n logger.info(`Retry ${retryCount}: Attempting to send request`, request.requestId);\n response = await next(request);\n logger.info(`Retry ${retryCount}: Received a response from request`, request.requestId);\n } catch (e: any) {\n logger.error(`Retry ${retryCount}: Received an error from request`, request.requestId);\n\n // RestErrors are valid targets for the retry strategies.\n // If none of the retry strategies can work with them, they will be thrown later in this policy.\n // If the received error is not a RestError, it is immediately thrown.\n responseError = e as RestError;\n if (!e || responseError.name !== \"RestError\") {\n throw e;\n }\n\n response = responseError.response;\n }\n\n if (request.abortSignal?.aborted) {\n logger.error(`Retry ${retryCount}: Request aborted.`);\n const abortError = new AbortError();\n throw abortError;\n }\n\n if (retryCount >= (options.maxRetries ?? DEFAULT_RETRY_POLICY_COUNT)) {\n logger.info(\n `Retry ${retryCount}: Maximum retries reached. Returning the last received response, or throwing the last received error.`,\n );\n if (responseError) {\n throw responseError;\n } else if (response) {\n return response;\n } else {\n throw new Error(\"Maximum retries reached with no response or error to throw\");\n }\n }\n\n logger.info(`Retry ${retryCount}: Processing ${strategies.length} retry strategies.`);\n\n strategiesLoop: for (const strategy of strategies) {\n const strategyLogger = strategy.logger || retryPolicyLogger;\n strategyLogger.info(`Retry ${retryCount}: Processing retry strategy ${strategy.name}.`);\n\n const modifiers = strategy.retry({\n retryCount,\n response,\n responseError,\n });\n\n if (modifiers.skipStrategy) {\n strategyLogger.info(`Retry ${retryCount}: Skipped.`);\n continue strategiesLoop;\n }\n\n const { errorToThrow, retryAfterInMs, redirectTo } = modifiers;\n\n if (errorToThrow) {\n strategyLogger.error(\n `Retry ${retryCount}: Retry strategy ${strategy.name} throws error:`,\n errorToThrow,\n );\n throw errorToThrow;\n }\n\n if (retryAfterInMs || retryAfterInMs === 0) {\n strategyLogger.info(\n `Retry ${retryCount}: Retry strategy ${strategy.name} retries after ${retryAfterInMs}`,\n );\n await delay(retryAfterInMs, undefined, { abortSignal: request.abortSignal });\n continue retryRequest;\n }\n\n if (redirectTo) {\n strategyLogger.info(\n `Retry ${retryCount}: Retry strategy ${strategy.name} redirects to ${redirectTo}`,\n );\n request.url = redirectTo;\n continue retryRequest;\n }\n }\n\n if (responseError) {\n logger.info(\n `None of the retry strategies could work with the received error. Throwing it.`,\n );\n throw responseError;\n }\n if (response) {\n logger.info(\n `None of the retry strategies could work with the received response. Returning it.`,\n );\n return response;\n }\n\n // If all the retries skip and there's no response,\n // we're still in the retry loop, so a new request will be sent\n // until `maxRetries` is reached.\n }\n },\n };\n}\n"]} \ No newline at end of file +{"version":3,"file":"retryPolicy.js","sourceRoot":"","sources":["../../../src/policies/retryPolicy.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAIlC,OAAO,EAAE,KAAK,EAAE,MAAM,oBAAoB,CAAC;AAC3C,OAAO,EAAoB,kBAAkB,EAAE,MAAM,eAAe,CAAC;AAGrE,OAAO,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAC;AACrD,OAAO,EAAE,0BAA0B,EAAE,MAAM,iBAAiB,CAAC;AAE7D,MAAM,iBAAiB,GAAG,kBAAkB,CAAC,gCAAgC,CAAC,CAAC;AAE/E;;GAEG;AACH,MAAM,eAAe,GAAG,aAAa,CAAC;AAgBtC;;GAEG;AACH,MAAM,UAAU,WAAW,CACzB,UAA2B,EAC3B,UAA8B,EAAE,UAAU,EAAE,0BAA0B,EAAE;IAExE,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,IAAI,iBAAiB,CAAC;IACnD,OAAO;QACL,IAAI,EAAE,eAAe;QACrB,KAAK,CAAC,WAAW,CAAC,OAAwB,EAAE,IAAiB;;YAC3D,IAAI,QAAsC,CAAC;YAC3C,IAAI,aAAoC,CAAC;YACzC,IAAI,UAAU,GAAG,CAAC,CAAC,CAAC;YAEpB,YAAY,EAAE,OAAO,IAAI,EAAE,CAAC;gBAC1B,UAAU,IAAI,CAAC,CAAC;gBAChB,QAAQ,GAAG,SAAS,CAAC;gBACrB,aAAa,GAAG,SAAS,CAAC;gBAE1B,IAAI,CAAC;oBACH,MAAM,CAAC,IAAI,CAAC,SAAS,UAAU,8BAA8B,EAAE,OAAO,CAAC,SAAS,CAAC,CAAC;oBAClF,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,CAAC;oBAC/B,MAAM,CAAC,IAAI,CAAC,SAAS,UAAU,oCAAoC,EAAE,OAAO,CAAC,SAAS,CAAC,CAAC;gBAC1F,CAAC;gBAAC,OAAO,CAAM,EAAE,CAAC;oBAChB,MAAM,CAAC,KAAK,CAAC,SAAS,UAAU,kCAAkC,EAAE,OAAO,CAAC,SAAS,CAAC,CAAC;oBAEvF,yDAAyD;oBACzD,gGAAgG;oBAChG,sEAAsE;oBACtE,aAAa,GAAG,CAAc,CAAC;oBAC/B,IAAI,CAAC,CAAC,IAAI,aAAa,CAAC,IAAI,KAAK,WAAW,EAAE,CAAC;wBAC7C,MAAM,CAAC,CAAC;oBACV,CAAC;oBAED,QAAQ,GAAG,aAAa,CAAC,QAAQ,CAAC;gBACpC,CAAC;gBAED,IAAI,MAAA,OAAO,CAAC,WAAW,0CAAE,OAAO,EAAE,CAAC;oBACjC,MAAM,CAAC,KAAK,CAAC,SAAS,UAAU,oBAAoB,CAAC,CAAC;oBACtD,MAAM,UAAU,GAAG,IAAI,UAAU,EAAE,CAAC;oBACpC,MAAM,UAAU,CAAC;gBACnB,CAAC;gBAED,IAAI,UAAU,IAAI,CAAC,MAAA,OAAO,CAAC,UAAU,mCAAI,0BAA0B,CAAC,EAAE,CAAC;oBACrE,MAAM,CAAC,IAAI,CACT,SAAS,UAAU,uGAAuG,CAC3H,CAAC;oBACF,IAAI,aAAa,EAAE,CAAC;wBAClB,MAAM,aAAa,CAAC;oBACtB,CAAC;yBAAM,IAAI,QAAQ,EAAE,CAAC;wBACpB,OAAO,QAAQ,CAAC;oBAClB,CAAC;yBAAM,CAAC;wBACN,MAAM,IAAI,KAAK,CAAC,4DAA4D,CAAC,CAAC;oBAChF,CAAC;gBACH,CAAC;gBAED,MAAM,CAAC,IAAI,CAAC,SAAS,UAAU,gBAAgB,UAAU,CAAC,MAAM,oBAAoB,CAAC,CAAC;gBAEtF,cAAc,EAAE,KAAK,MAAM,QAAQ,IAAI,UAAU,EAAE,CAAC;oBAClD,MAAM,cAAc,GAAG,QAAQ,CAAC,MAAM,IAAI,iBAAiB,CAAC;oBAC5D,cAAc,CAAC,IAAI,CAAC,SAAS,UAAU,+BAA+B,QAAQ,CAAC,IAAI,GAAG,CAAC,CAAC;oBAExF,MAAM,SAAS,GAAG,QAAQ,CAAC,KAAK,CAAC;wBAC/B,UAAU;wBACV,QAAQ;wBACR,aAAa;qBACd,CAAC,CAAC;oBAEH,IAAI,SAAS,CAAC,YAAY,EAAE,CAAC;wBAC3B,cAAc,CAAC,IAAI,CAAC,SAAS,UAAU,YAAY,CAAC,CAAC;wBACrD,SAAS,cAAc,CAAC;oBAC1B,CAAC;oBAED,MAAM,EAAE,YAAY,EAAE,cAAc,EAAE,UAAU,EAAE,GAAG,SAAS,CAAC;oBAE/D,IAAI,YAAY,EAAE,CAAC;wBACjB,cAAc,CAAC,KAAK,CAClB,SAAS,UAAU,oBAAoB,QAAQ,CAAC,IAAI,gBAAgB,EACpE,YAAY,CACb,CAAC;wBACF,MAAM,YAAY,CAAC;oBACrB,CAAC;oBAED,IAAI,cAAc,IAAI,cAAc,KAAK,CAAC,EAAE,CAAC;wBAC3C,cAAc,CAAC,IAAI,CACjB,SAAS,UAAU,oBAAoB,QAAQ,CAAC,IAAI,kBAAkB,cAAc,EAAE,CACvF,CAAC;wBACF,MAAM,KAAK,CAAC,cAAc,EAAE,SAAS,EAAE,EAAE,WAAW,EAAE,OAAO,CAAC,WAAW,EAAE,CAAC,CAAC;wBAC7E,SAAS,YAAY,CAAC;oBACxB,CAAC;oBAED,IAAI,UAAU,EAAE,CAAC;wBACf,cAAc,CAAC,IAAI,CACjB,SAAS,UAAU,oBAAoB,QAAQ,CAAC,IAAI,iBAAiB,UAAU,EAAE,CAClF,CAAC;wBACF,OAAO,CAAC,GAAG,GAAG,UAAU,CAAC;wBACzB,SAAS,YAAY,CAAC;oBACxB,CAAC;gBACH,CAAC;gBAED,IAAI,aAAa,EAAE,CAAC;oBAClB,MAAM,CAAC,IAAI,CACT,+EAA+E,CAChF,CAAC;oBACF,MAAM,aAAa,CAAC;gBACtB,CAAC;gBACD,IAAI,QAAQ,EAAE,CAAC;oBACb,MAAM,CAAC,IAAI,CACT,mFAAmF,CACpF,CAAC;oBACF,OAAO,QAAQ,CAAC;gBAClB,CAAC;gBAED,mDAAmD;gBACnD,+DAA+D;gBAC/D,iCAAiC;YACnC,CAAC;QACH,CAAC;KACF,CAAC;AACJ,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport type { PipelineRequest, PipelineResponse, SendRequest } from \"../interfaces.js\";\nimport type { PipelinePolicy } from \"../pipeline.js\";\nimport { delay } from \"../util/helpers.js\";\nimport { type AzureLogger, createClientLogger } from \"@azure/logger\";\nimport type { RetryStrategy } from \"../retryStrategies/retryStrategy.js\";\nimport type { RestError } from \"../restError.js\";\nimport { AbortError } from \"@azure/abort-controller\";\nimport { DEFAULT_RETRY_POLICY_COUNT } from \"../constants.js\";\n\nconst retryPolicyLogger = createClientLogger(\"core-rest-pipeline retryPolicy\");\n\n/**\n * The programmatic identifier of the retryPolicy.\n */\nconst retryPolicyName = \"retryPolicy\";\n\n/**\n * Options to the {@link retryPolicy}\n */\nexport interface RetryPolicyOptions {\n /**\n * Maximum number of retries. If not specified, it will limit to 3 retries.\n */\n maxRetries?: number;\n /**\n * Logger. If it's not provided, a default logger is used.\n */\n logger?: AzureLogger;\n}\n\n/**\n * retryPolicy is a generic policy to enable retrying requests when certain conditions are met\n */\nexport function retryPolicy(\n strategies: RetryStrategy[],\n options: RetryPolicyOptions = { maxRetries: DEFAULT_RETRY_POLICY_COUNT },\n): PipelinePolicy {\n const logger = options.logger || retryPolicyLogger;\n return {\n name: retryPolicyName,\n async sendRequest(request: PipelineRequest, next: SendRequest): Promise {\n let response: PipelineResponse | undefined;\n let responseError: RestError | undefined;\n let retryCount = -1;\n\n retryRequest: while (true) {\n retryCount += 1;\n response = undefined;\n responseError = undefined;\n\n try {\n logger.info(`Retry ${retryCount}: Attempting to send request`, request.requestId);\n response = await next(request);\n logger.info(`Retry ${retryCount}: Received a response from request`, request.requestId);\n } catch (e: any) {\n logger.error(`Retry ${retryCount}: Received an error from request`, request.requestId);\n\n // RestErrors are valid targets for the retry strategies.\n // If none of the retry strategies can work with them, they will be thrown later in this policy.\n // If the received error is not a RestError, it is immediately thrown.\n responseError = e as RestError;\n if (!e || responseError.name !== \"RestError\") {\n throw e;\n }\n\n response = responseError.response;\n }\n\n if (request.abortSignal?.aborted) {\n logger.error(`Retry ${retryCount}: Request aborted.`);\n const abortError = new AbortError();\n throw abortError;\n }\n\n if (retryCount >= (options.maxRetries ?? DEFAULT_RETRY_POLICY_COUNT)) {\n logger.info(\n `Retry ${retryCount}: Maximum retries reached. Returning the last received response, or throwing the last received error.`,\n );\n if (responseError) {\n throw responseError;\n } else if (response) {\n return response;\n } else {\n throw new Error(\"Maximum retries reached with no response or error to throw\");\n }\n }\n\n logger.info(`Retry ${retryCount}: Processing ${strategies.length} retry strategies.`);\n\n strategiesLoop: for (const strategy of strategies) {\n const strategyLogger = strategy.logger || retryPolicyLogger;\n strategyLogger.info(`Retry ${retryCount}: Processing retry strategy ${strategy.name}.`);\n\n const modifiers = strategy.retry({\n retryCount,\n response,\n responseError,\n });\n\n if (modifiers.skipStrategy) {\n strategyLogger.info(`Retry ${retryCount}: Skipped.`);\n continue strategiesLoop;\n }\n\n const { errorToThrow, retryAfterInMs, redirectTo } = modifiers;\n\n if (errorToThrow) {\n strategyLogger.error(\n `Retry ${retryCount}: Retry strategy ${strategy.name} throws error:`,\n errorToThrow,\n );\n throw errorToThrow;\n }\n\n if (retryAfterInMs || retryAfterInMs === 0) {\n strategyLogger.info(\n `Retry ${retryCount}: Retry strategy ${strategy.name} retries after ${retryAfterInMs}`,\n );\n await delay(retryAfterInMs, undefined, { abortSignal: request.abortSignal });\n continue retryRequest;\n }\n\n if (redirectTo) {\n strategyLogger.info(\n `Retry ${retryCount}: Retry strategy ${strategy.name} redirects to ${redirectTo}`,\n );\n request.url = redirectTo;\n continue retryRequest;\n }\n }\n\n if (responseError) {\n logger.info(\n `None of the retry strategies could work with the received error. Throwing it.`,\n );\n throw responseError;\n }\n if (response) {\n logger.info(\n `None of the retry strategies could work with the received response. Returning it.`,\n );\n return response;\n }\n\n // If all the retries skip and there's no response,\n // we're still in the retry loop, so a new request will be sent\n // until `maxRetries` is reached.\n }\n },\n };\n}\n"]} \ No newline at end of file diff --git a/node_modules/@azure/core-rest-pipeline/dist/browser/policies/tracingPolicy.js b/node_modules/@azure/core-rest-pipeline/dist/browser/policies/tracingPolicy.js index 1be17ec3..455c2561 100644 --- a/node_modules/@azure/core-rest-pipeline/dist/browser/policies/tracingPolicy.js +++ b/node_modules/@azure/core-rest-pipeline/dist/browser/policies/tracingPolicy.js @@ -115,9 +115,14 @@ function tryProcessResponse(span, response) { if (serviceRequestId) { span.setAttribute("serviceRequestId", serviceRequestId); } - span.setStatus({ - status: "success", - }); + // Per semantic conventions, only set the status to error if the status code is 4xx or 5xx. + // Otherwise, the status MUST remain unset. + // https://opentelemetry.io/docs/specs/semconv/http/http-spans/#status + if (response.status >= 400) { + span.setStatus({ + status: "error", + }); + } span.end(); } catch (e) { diff --git a/node_modules/@azure/core-rest-pipeline/dist/browser/policies/tracingPolicy.js.map b/node_modules/@azure/core-rest-pipeline/dist/browser/policies/tracingPolicy.js.map index e60e964c..b0ced4d4 100644 --- a/node_modules/@azure/core-rest-pipeline/dist/browser/policies/tracingPolicy.js.map +++ b/node_modules/@azure/core-rest-pipeline/dist/browser/policies/tracingPolicy.js.map @@ -1 +1 @@ -{"version":3,"file":"tracingPolicy.js","sourceRoot":"","sources":["../../../src/policies/tracingPolicy.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAElC,OAAO,EAIL,mBAAmB,GACpB,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AAG9C,OAAO,EAAE,iBAAiB,EAAE,MAAM,sBAAsB,CAAC;AACzD,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAC;AACnC,OAAO,EAAE,eAAe,EAAE,OAAO,EAAE,MAAM,kBAAkB,CAAC;AAC5D,OAAO,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AAC9C,OAAO,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAC;AAEjD;;GAEG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,eAAe,CAAC;AAmBjD;;;;;GAKG;AACH,MAAM,UAAU,aAAa,CAAC,UAAgC,EAAE;IAC9D,MAAM,gBAAgB,GAAG,iBAAiB,CAAC,OAAO,CAAC,eAAe,CAAC,CAAC;IACpE,MAAM,SAAS,GAAG,IAAI,SAAS,CAAC;QAC9B,gCAAgC,EAAE,OAAO,CAAC,gCAAgC;KAC3E,CAAC,CAAC;IACH,MAAM,aAAa,GAAG,sBAAsB,EAAE,CAAC;IAE/C,OAAO;QACL,IAAI,EAAE,iBAAiB;QACvB,KAAK,CAAC,WAAW,CAAC,OAAwB,EAAE,IAAiB;;YAC3D,IAAI,CAAC,aAAa,EAAE,CAAC;gBACnB,OAAO,IAAI,CAAC,OAAO,CAAC,CAAC;YACvB,CAAC;YAED,MAAM,SAAS,GAAG,MAAM,gBAAgB,CAAC;YAEzC,MAAM,cAAc,GAAG;gBACrB,UAAU,EAAE,SAAS,CAAC,WAAW,CAAC,OAAO,CAAC,GAAG,CAAC;gBAC9C,aAAa,EAAE,OAAO,CAAC,MAAM;gBAC7B,iBAAiB,EAAE,SAAS;gBAC5B,SAAS,EAAE,OAAO,CAAC,SAAS;aAC7B,CAAC;YACF,IAAI,SAAS,EAAE,CAAC;gBACd,cAAc,CAAC,iBAAiB,CAAC,GAAG,SAAS,CAAC;YAChD,CAAC;YAED,MAAM,EAAE,IAAI,EAAE,cAAc,EAAE,GAAG,MAAA,aAAa,CAAC,aAAa,EAAE,OAAO,EAAE,cAAc,CAAC,mCAAI,EAAE,CAAC;YAE7F,IAAI,CAAC,IAAI,IAAI,CAAC,cAAc,EAAE,CAAC;gBAC7B,OAAO,IAAI,CAAC,OAAO,CAAC,CAAC;YACvB,CAAC;YAED,IAAI,CAAC;gBACH,MAAM,QAAQ,GAAG,MAAM,aAAa,CAAC,WAAW,CAAC,cAAc,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;gBAChF,kBAAkB,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;gBACnC,OAAO,QAAQ,CAAC;YAClB,CAAC;YAAC,OAAO,GAAQ,EAAE,CAAC;gBAClB,eAAe,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;gBAC3B,MAAM,GAAG,CAAC;YACZ,CAAC;QACH,CAAC;KACF,CAAC;AACJ,CAAC;AAED,SAAS,sBAAsB;IAC7B,IAAI,CAAC;QACH,OAAO,mBAAmB,CAAC;YACzB,SAAS,EAAE,EAAE;YACb,WAAW,EAAE,2BAA2B;YACxC,cAAc,EAAE,WAAW;SAC5B,CAAC,CAAC;IACL,CAAC;IAAC,OAAO,CAAU,EAAE,CAAC;QACpB,MAAM,CAAC,OAAO,CAAC,0CAA0C,eAAe,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;QAC/E,OAAO,SAAS,CAAC;IACnB,CAAC;AACH,CAAC;AAED,SAAS,aAAa,CACpB,aAA4B,EAC5B,OAAwB,EACxB,cAAuC;IAEvC,IAAI,CAAC;QACH,oFAAoF;QACpF,MAAM,EAAE,IAAI,EAAE,cAAc,EAAE,GAAG,aAAa,CAAC,SAAS,CACtD,QAAQ,OAAO,CAAC,MAAM,EAAE,EACxB,EAAE,cAAc,EAAE,OAAO,CAAC,cAAc,EAAE,EAC1C;YACE,QAAQ,EAAE,QAAQ;YAClB,cAAc;SACf,CACF,CAAC;QAEF,wDAAwD;QACxD,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,EAAE,CAAC;YACxB,IAAI,CAAC,GAAG,EAAE,CAAC;YACX,OAAO,SAAS,CAAC;QACnB,CAAC;QAED,cAAc;QACd,MAAM,OAAO,GAAG,aAAa,CAAC,oBAAoB,CAChD,cAAc,CAAC,cAAc,CAAC,cAAc,CAC7C,CAAC;QACF,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC;YACnD,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;QAClC,CAAC;QACD,OAAO,EAAE,IAAI,EAAE,cAAc,EAAE,cAAc,CAAC,cAAc,CAAC,cAAc,EAAE,CAAC;IAChF,CAAC;IAAC,OAAO,CAAM,EAAE,CAAC;QAChB,MAAM,CAAC,OAAO,CAAC,qDAAqD,eAAe,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;QAC1F,OAAO,SAAS,CAAC;IACnB,CAAC;AACH,CAAC;AAED,SAAS,eAAe,CAAC,IAAiB,EAAE,KAAc;IACxD,IAAI,CAAC;QACH,IAAI,CAAC,SAAS,CAAC;YACb,MAAM,EAAE,OAAO;YACf,KAAK,EAAE,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS;SAC1C,CAAC,CAAC;QACH,IAAI,WAAW,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,UAAU,EAAE,CAAC;YAC3C,IAAI,CAAC,YAAY,CAAC,kBAAkB,EAAE,KAAK,CAAC,UAAU,CAAC,CAAC;QAC1D,CAAC;QACD,IAAI,CAAC,GAAG,EAAE,CAAC;IACb,CAAC;IAAC,OAAO,CAAM,EAAE,CAAC;QAChB,MAAM,CAAC,OAAO,CAAC,qDAAqD,eAAe,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;IAC5F,CAAC;AACH,CAAC;AAED,SAAS,kBAAkB,CAAC,IAAiB,EAAE,QAA0B;IACvE,IAAI,CAAC;QACH,IAAI,CAAC,YAAY,CAAC,kBAAkB,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAC;QACvD,MAAM,gBAAgB,GAAG,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,iBAAiB,CAAC,CAAC;QACjE,IAAI,gBAAgB,EAAE,CAAC;YACrB,IAAI,CAAC,YAAY,CAAC,kBAAkB,EAAE,gBAAgB,CAAC,CAAC;QAC1D,CAAC;QACD,IAAI,CAAC,SAAS,CAAC;YACb,MAAM,EAAE,SAAS;SAClB,CAAC,CAAC;QACH,IAAI,CAAC,GAAG,EAAE,CAAC;IACb,CAAC;IAAC,OAAO,CAAM,EAAE,CAAC;QAChB,MAAM,CAAC,OAAO,CAAC,qDAAqD,eAAe,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;IAC5F,CAAC;AACH,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport {\n type TracingClient,\n type TracingContext,\n type TracingSpan,\n createTracingClient,\n} from \"@azure/core-tracing\";\nimport { SDK_VERSION } from \"../constants.js\";\nimport type { PipelineRequest, PipelineResponse, SendRequest } from \"../interfaces.js\";\nimport type { PipelinePolicy } from \"../pipeline.js\";\nimport { getUserAgentValue } from \"../util/userAgent.js\";\nimport { logger } from \"../log.js\";\nimport { getErrorMessage, isError } from \"@azure/core-util\";\nimport { isRestError } from \"../restError.js\";\nimport { Sanitizer } from \"../util/sanitizer.js\";\n\n/**\n * The programmatic identifier of the tracingPolicy.\n */\nexport const tracingPolicyName = \"tracingPolicy\";\n\n/**\n * Options to configure the tracing policy.\n */\nexport interface TracingPolicyOptions {\n /**\n * String prefix to add to the user agent logged as metadata\n * on the generated Span.\n * Defaults to an empty string.\n */\n userAgentPrefix?: string;\n /**\n * Query string names whose values will be logged when logging is enabled. By default no\n * query string values are logged.\n */\n additionalAllowedQueryParameters?: string[];\n}\n\n/**\n * A simple policy to create OpenTelemetry Spans for each request made by the pipeline\n * that has SpanOptions with a parent.\n * Requests made without a parent Span will not be recorded.\n * @param options - Options to configure the telemetry logged by the tracing policy.\n */\nexport function tracingPolicy(options: TracingPolicyOptions = {}): PipelinePolicy {\n const userAgentPromise = getUserAgentValue(options.userAgentPrefix);\n const sanitizer = new Sanitizer({\n additionalAllowedQueryParameters: options.additionalAllowedQueryParameters,\n });\n const tracingClient = tryCreateTracingClient();\n\n return {\n name: tracingPolicyName,\n async sendRequest(request: PipelineRequest, next: SendRequest): Promise {\n if (!tracingClient) {\n return next(request);\n }\n\n const userAgent = await userAgentPromise;\n\n const spanAttributes = {\n \"http.url\": sanitizer.sanitizeUrl(request.url),\n \"http.method\": request.method,\n \"http.user_agent\": userAgent,\n requestId: request.requestId,\n };\n if (userAgent) {\n spanAttributes[\"http.user_agent\"] = userAgent;\n }\n\n const { span, tracingContext } = tryCreateSpan(tracingClient, request, spanAttributes) ?? {};\n\n if (!span || !tracingContext) {\n return next(request);\n }\n\n try {\n const response = await tracingClient.withContext(tracingContext, next, request);\n tryProcessResponse(span, response);\n return response;\n } catch (err: any) {\n tryProcessError(span, err);\n throw err;\n }\n },\n };\n}\n\nfunction tryCreateTracingClient(): TracingClient | undefined {\n try {\n return createTracingClient({\n namespace: \"\",\n packageName: \"@azure/core-rest-pipeline\",\n packageVersion: SDK_VERSION,\n });\n } catch (e: unknown) {\n logger.warning(`Error when creating the TracingClient: ${getErrorMessage(e)}`);\n return undefined;\n }\n}\n\nfunction tryCreateSpan(\n tracingClient: TracingClient,\n request: PipelineRequest,\n spanAttributes: Record,\n): { span: TracingSpan; tracingContext: TracingContext } | undefined {\n try {\n // As per spec, we do not need to differentiate between HTTP and HTTPS in span name.\n const { span, updatedOptions } = tracingClient.startSpan(\n `HTTP ${request.method}`,\n { tracingOptions: request.tracingOptions },\n {\n spanKind: \"client\",\n spanAttributes,\n },\n );\n\n // If the span is not recording, don't do any more work.\n if (!span.isRecording()) {\n span.end();\n return undefined;\n }\n\n // set headers\n const headers = tracingClient.createRequestHeaders(\n updatedOptions.tracingOptions.tracingContext,\n );\n for (const [key, value] of Object.entries(headers)) {\n request.headers.set(key, value);\n }\n return { span, tracingContext: updatedOptions.tracingOptions.tracingContext };\n } catch (e: any) {\n logger.warning(`Skipping creating a tracing span due to an error: ${getErrorMessage(e)}`);\n return undefined;\n }\n}\n\nfunction tryProcessError(span: TracingSpan, error: unknown): void {\n try {\n span.setStatus({\n status: \"error\",\n error: isError(error) ? error : undefined,\n });\n if (isRestError(error) && error.statusCode) {\n span.setAttribute(\"http.status_code\", error.statusCode);\n }\n span.end();\n } catch (e: any) {\n logger.warning(`Skipping tracing span processing due to an error: ${getErrorMessage(e)}`);\n }\n}\n\nfunction tryProcessResponse(span: TracingSpan, response: PipelineResponse): void {\n try {\n span.setAttribute(\"http.status_code\", response.status);\n const serviceRequestId = response.headers.get(\"x-ms-request-id\");\n if (serviceRequestId) {\n span.setAttribute(\"serviceRequestId\", serviceRequestId);\n }\n span.setStatus({\n status: \"success\",\n });\n span.end();\n } catch (e: any) {\n logger.warning(`Skipping tracing span processing due to an error: ${getErrorMessage(e)}`);\n }\n}\n"]} \ No newline at end of file +{"version":3,"file":"tracingPolicy.js","sourceRoot":"","sources":["../../../src/policies/tracingPolicy.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAElC,OAAO,EAIL,mBAAmB,GACpB,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AAG9C,OAAO,EAAE,iBAAiB,EAAE,MAAM,sBAAsB,CAAC;AACzD,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAC;AACnC,OAAO,EAAE,eAAe,EAAE,OAAO,EAAE,MAAM,kBAAkB,CAAC;AAC5D,OAAO,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AAC9C,OAAO,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAC;AAEjD;;GAEG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,eAAe,CAAC;AAmBjD;;;;;GAKG;AACH,MAAM,UAAU,aAAa,CAAC,UAAgC,EAAE;IAC9D,MAAM,gBAAgB,GAAG,iBAAiB,CAAC,OAAO,CAAC,eAAe,CAAC,CAAC;IACpE,MAAM,SAAS,GAAG,IAAI,SAAS,CAAC;QAC9B,gCAAgC,EAAE,OAAO,CAAC,gCAAgC;KAC3E,CAAC,CAAC;IACH,MAAM,aAAa,GAAG,sBAAsB,EAAE,CAAC;IAE/C,OAAO;QACL,IAAI,EAAE,iBAAiB;QACvB,KAAK,CAAC,WAAW,CAAC,OAAwB,EAAE,IAAiB;;YAC3D,IAAI,CAAC,aAAa,EAAE,CAAC;gBACnB,OAAO,IAAI,CAAC,OAAO,CAAC,CAAC;YACvB,CAAC;YAED,MAAM,SAAS,GAAG,MAAM,gBAAgB,CAAC;YAEzC,MAAM,cAAc,GAAG;gBACrB,UAAU,EAAE,SAAS,CAAC,WAAW,CAAC,OAAO,CAAC,GAAG,CAAC;gBAC9C,aAAa,EAAE,OAAO,CAAC,MAAM;gBAC7B,iBAAiB,EAAE,SAAS;gBAC5B,SAAS,EAAE,OAAO,CAAC,SAAS;aAC7B,CAAC;YACF,IAAI,SAAS,EAAE,CAAC;gBACd,cAAc,CAAC,iBAAiB,CAAC,GAAG,SAAS,CAAC;YAChD,CAAC;YAED,MAAM,EAAE,IAAI,EAAE,cAAc,EAAE,GAAG,MAAA,aAAa,CAAC,aAAa,EAAE,OAAO,EAAE,cAAc,CAAC,mCAAI,EAAE,CAAC;YAE7F,IAAI,CAAC,IAAI,IAAI,CAAC,cAAc,EAAE,CAAC;gBAC7B,OAAO,IAAI,CAAC,OAAO,CAAC,CAAC;YACvB,CAAC;YAED,IAAI,CAAC;gBACH,MAAM,QAAQ,GAAG,MAAM,aAAa,CAAC,WAAW,CAAC,cAAc,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;gBAChF,kBAAkB,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;gBACnC,OAAO,QAAQ,CAAC;YAClB,CAAC;YAAC,OAAO,GAAQ,EAAE,CAAC;gBAClB,eAAe,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;gBAC3B,MAAM,GAAG,CAAC;YACZ,CAAC;QACH,CAAC;KACF,CAAC;AACJ,CAAC;AAED,SAAS,sBAAsB;IAC7B,IAAI,CAAC;QACH,OAAO,mBAAmB,CAAC;YACzB,SAAS,EAAE,EAAE;YACb,WAAW,EAAE,2BAA2B;YACxC,cAAc,EAAE,WAAW;SAC5B,CAAC,CAAC;IACL,CAAC;IAAC,OAAO,CAAU,EAAE,CAAC;QACpB,MAAM,CAAC,OAAO,CAAC,0CAA0C,eAAe,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;QAC/E,OAAO,SAAS,CAAC;IACnB,CAAC;AACH,CAAC;AAED,SAAS,aAAa,CACpB,aAA4B,EAC5B,OAAwB,EACxB,cAAuC;IAEvC,IAAI,CAAC;QACH,oFAAoF;QACpF,MAAM,EAAE,IAAI,EAAE,cAAc,EAAE,GAAG,aAAa,CAAC,SAAS,CACtD,QAAQ,OAAO,CAAC,MAAM,EAAE,EACxB,EAAE,cAAc,EAAE,OAAO,CAAC,cAAc,EAAE,EAC1C;YACE,QAAQ,EAAE,QAAQ;YAClB,cAAc;SACf,CACF,CAAC;QAEF,wDAAwD;QACxD,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,EAAE,CAAC;YACxB,IAAI,CAAC,GAAG,EAAE,CAAC;YACX,OAAO,SAAS,CAAC;QACnB,CAAC;QAED,cAAc;QACd,MAAM,OAAO,GAAG,aAAa,CAAC,oBAAoB,CAChD,cAAc,CAAC,cAAc,CAAC,cAAc,CAC7C,CAAC;QACF,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC;YACnD,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;QAClC,CAAC;QACD,OAAO,EAAE,IAAI,EAAE,cAAc,EAAE,cAAc,CAAC,cAAc,CAAC,cAAc,EAAE,CAAC;IAChF,CAAC;IAAC,OAAO,CAAM,EAAE,CAAC;QAChB,MAAM,CAAC,OAAO,CAAC,qDAAqD,eAAe,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;QAC1F,OAAO,SAAS,CAAC;IACnB,CAAC;AACH,CAAC;AAED,SAAS,eAAe,CAAC,IAAiB,EAAE,KAAc;IACxD,IAAI,CAAC;QACH,IAAI,CAAC,SAAS,CAAC;YACb,MAAM,EAAE,OAAO;YACf,KAAK,EAAE,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS;SAC1C,CAAC,CAAC;QACH,IAAI,WAAW,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,UAAU,EAAE,CAAC;YAC3C,IAAI,CAAC,YAAY,CAAC,kBAAkB,EAAE,KAAK,CAAC,UAAU,CAAC,CAAC;QAC1D,CAAC;QACD,IAAI,CAAC,GAAG,EAAE,CAAC;IACb,CAAC;IAAC,OAAO,CAAM,EAAE,CAAC;QAChB,MAAM,CAAC,OAAO,CAAC,qDAAqD,eAAe,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;IAC5F,CAAC;AACH,CAAC;AAED,SAAS,kBAAkB,CAAC,IAAiB,EAAE,QAA0B;IACvE,IAAI,CAAC;QACH,IAAI,CAAC,YAAY,CAAC,kBAAkB,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAC;QACvD,MAAM,gBAAgB,GAAG,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,iBAAiB,CAAC,CAAC;QACjE,IAAI,gBAAgB,EAAE,CAAC;YACrB,IAAI,CAAC,YAAY,CAAC,kBAAkB,EAAE,gBAAgB,CAAC,CAAC;QAC1D,CAAC;QACD,2FAA2F;QAC3F,2CAA2C;QAC3C,sEAAsE;QACtE,IAAI,QAAQ,CAAC,MAAM,IAAI,GAAG,EAAE,CAAC;YAC3B,IAAI,CAAC,SAAS,CAAC;gBACb,MAAM,EAAE,OAAO;aAChB,CAAC,CAAC;QACL,CAAC;QACD,IAAI,CAAC,GAAG,EAAE,CAAC;IACb,CAAC;IAAC,OAAO,CAAM,EAAE,CAAC;QAChB,MAAM,CAAC,OAAO,CAAC,qDAAqD,eAAe,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;IAC5F,CAAC;AACH,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport {\n type TracingClient,\n type TracingContext,\n type TracingSpan,\n createTracingClient,\n} from \"@azure/core-tracing\";\nimport { SDK_VERSION } from \"../constants.js\";\nimport type { PipelineRequest, PipelineResponse, SendRequest } from \"../interfaces.js\";\nimport type { PipelinePolicy } from \"../pipeline.js\";\nimport { getUserAgentValue } from \"../util/userAgent.js\";\nimport { logger } from \"../log.js\";\nimport { getErrorMessage, isError } from \"@azure/core-util\";\nimport { isRestError } from \"../restError.js\";\nimport { Sanitizer } from \"../util/sanitizer.js\";\n\n/**\n * The programmatic identifier of the tracingPolicy.\n */\nexport const tracingPolicyName = \"tracingPolicy\";\n\n/**\n * Options to configure the tracing policy.\n */\nexport interface TracingPolicyOptions {\n /**\n * String prefix to add to the user agent logged as metadata\n * on the generated Span.\n * Defaults to an empty string.\n */\n userAgentPrefix?: string;\n /**\n * Query string names whose values will be logged when logging is enabled. By default no\n * query string values are logged.\n */\n additionalAllowedQueryParameters?: string[];\n}\n\n/**\n * A simple policy to create OpenTelemetry Spans for each request made by the pipeline\n * that has SpanOptions with a parent.\n * Requests made without a parent Span will not be recorded.\n * @param options - Options to configure the telemetry logged by the tracing policy.\n */\nexport function tracingPolicy(options: TracingPolicyOptions = {}): PipelinePolicy {\n const userAgentPromise = getUserAgentValue(options.userAgentPrefix);\n const sanitizer = new Sanitizer({\n additionalAllowedQueryParameters: options.additionalAllowedQueryParameters,\n });\n const tracingClient = tryCreateTracingClient();\n\n return {\n name: tracingPolicyName,\n async sendRequest(request: PipelineRequest, next: SendRequest): Promise {\n if (!tracingClient) {\n return next(request);\n }\n\n const userAgent = await userAgentPromise;\n\n const spanAttributes = {\n \"http.url\": sanitizer.sanitizeUrl(request.url),\n \"http.method\": request.method,\n \"http.user_agent\": userAgent,\n requestId: request.requestId,\n };\n if (userAgent) {\n spanAttributes[\"http.user_agent\"] = userAgent;\n }\n\n const { span, tracingContext } = tryCreateSpan(tracingClient, request, spanAttributes) ?? {};\n\n if (!span || !tracingContext) {\n return next(request);\n }\n\n try {\n const response = await tracingClient.withContext(tracingContext, next, request);\n tryProcessResponse(span, response);\n return response;\n } catch (err: any) {\n tryProcessError(span, err);\n throw err;\n }\n },\n };\n}\n\nfunction tryCreateTracingClient(): TracingClient | undefined {\n try {\n return createTracingClient({\n namespace: \"\",\n packageName: \"@azure/core-rest-pipeline\",\n packageVersion: SDK_VERSION,\n });\n } catch (e: unknown) {\n logger.warning(`Error when creating the TracingClient: ${getErrorMessage(e)}`);\n return undefined;\n }\n}\n\nfunction tryCreateSpan(\n tracingClient: TracingClient,\n request: PipelineRequest,\n spanAttributes: Record,\n): { span: TracingSpan; tracingContext: TracingContext } | undefined {\n try {\n // As per spec, we do not need to differentiate between HTTP and HTTPS in span name.\n const { span, updatedOptions } = tracingClient.startSpan(\n `HTTP ${request.method}`,\n { tracingOptions: request.tracingOptions },\n {\n spanKind: \"client\",\n spanAttributes,\n },\n );\n\n // If the span is not recording, don't do any more work.\n if (!span.isRecording()) {\n span.end();\n return undefined;\n }\n\n // set headers\n const headers = tracingClient.createRequestHeaders(\n updatedOptions.tracingOptions.tracingContext,\n );\n for (const [key, value] of Object.entries(headers)) {\n request.headers.set(key, value);\n }\n return { span, tracingContext: updatedOptions.tracingOptions.tracingContext };\n } catch (e: any) {\n logger.warning(`Skipping creating a tracing span due to an error: ${getErrorMessage(e)}`);\n return undefined;\n }\n}\n\nfunction tryProcessError(span: TracingSpan, error: unknown): void {\n try {\n span.setStatus({\n status: \"error\",\n error: isError(error) ? error : undefined,\n });\n if (isRestError(error) && error.statusCode) {\n span.setAttribute(\"http.status_code\", error.statusCode);\n }\n span.end();\n } catch (e: any) {\n logger.warning(`Skipping tracing span processing due to an error: ${getErrorMessage(e)}`);\n }\n}\n\nfunction tryProcessResponse(span: TracingSpan, response: PipelineResponse): void {\n try {\n span.setAttribute(\"http.status_code\", response.status);\n const serviceRequestId = response.headers.get(\"x-ms-request-id\");\n if (serviceRequestId) {\n span.setAttribute(\"serviceRequestId\", serviceRequestId);\n }\n // Per semantic conventions, only set the status to error if the status code is 4xx or 5xx.\n // Otherwise, the status MUST remain unset.\n // https://opentelemetry.io/docs/specs/semconv/http/http-spans/#status\n if (response.status >= 400) {\n span.setStatus({\n status: \"error\",\n });\n }\n span.end();\n } catch (e: any) {\n logger.warning(`Skipping tracing span processing due to an error: ${getErrorMessage(e)}`);\n }\n}\n"]} \ No newline at end of file diff --git a/node_modules/@azure/core-rest-pipeline/dist/browser/restError.d.ts b/node_modules/@azure/core-rest-pipeline/dist/browser/restError.d.ts index 0bb2fc48..66264448 100644 --- a/node_modules/@azure/core-rest-pipeline/dist/browser/restError.d.ts +++ b/node_modules/@azure/core-rest-pipeline/dist/browser/restError.d.ts @@ -24,6 +24,7 @@ export interface RestErrorOptions { * A custom error type for failed pipeline requests. */ export declare class RestError extends Error { + [x: symbol]: () => string; /** * Something went wrong when making the request. * This means the actual request failed for some reason, diff --git a/node_modules/@azure/core-rest-pipeline/dist/browser/restError.d.ts.map b/node_modules/@azure/core-rest-pipeline/dist/browser/restError.d.ts.map index d6e29e6c..a10965e3 100644 --- a/node_modules/@azure/core-rest-pipeline/dist/browser/restError.d.ts.map +++ b/node_modules/@azure/core-rest-pipeline/dist/browser/restError.d.ts.map @@ -1 +1 @@ -{"version":3,"file":"restError.d.ts","sourceRoot":"","sources":["../../src/restError.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,eAAe,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAC;AAMzE;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,OAAO,CAAC,EAAE,eAAe,CAAC;IAC1B;;OAEG;IACH,QAAQ,CAAC,EAAE,gBAAgB,CAAC;CAC7B;AAED;;GAEG;AACH,qBAAa,SAAU,SAAQ,KAAK;IAClC;;;;OAIG;IACH,MAAM,CAAC,QAAQ,CAAC,kBAAkB,EAAE,MAAM,CAAwB;IAClE;;;OAGG;IACH,MAAM,CAAC,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAiB;IAEpD;;OAEG;IACI,IAAI,CAAC,EAAE,MAAM,CAAC;IACrB;;OAEG;IACI,UAAU,CAAC,EAAE,MAAM,CAAC;IAC3B;;;OAGG;IACI,OAAO,CAAC,EAAE,eAAe,CAAC;IACjC;;;OAGG;IACI,QAAQ,CAAC,EAAE,gBAAgB,CAAC;IACnC;;OAEG;IACI,OAAO,CAAC,EAAE,OAAO,CAAC;gBAEb,OAAO,EAAE,MAAM,EAAE,OAAO,GAAE,gBAAqB;CA4B5D;AAED;;;GAGG;AACH,wBAAgB,WAAW,CAAC,CAAC,EAAE,OAAO,GAAG,CAAC,IAAI,SAAS,CAKtD"} \ No newline at end of file +{"version":3,"file":"restError.d.ts","sourceRoot":"","sources":["../../src/restError.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,eAAe,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAC;AAMzE;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,OAAO,CAAC,EAAE,eAAe,CAAC;IAC1B;;OAEG;IACH,QAAQ,CAAC,EAAE,gBAAgB,CAAC;CAC7B;AAED;;GAEG;AACH,qBAAa,SAAU,SAAQ,KAAK;uBAuDtB,MAAM;IAtDlB;;;;OAIG;IACH,MAAM,CAAC,QAAQ,CAAC,kBAAkB,EAAE,MAAM,CAAwB;IAClE;;;OAGG;IACH,MAAM,CAAC,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAiB;IAEpD;;OAEG;IACI,IAAI,CAAC,EAAE,MAAM,CAAC;IACrB;;OAEG;IACI,UAAU,CAAC,EAAE,MAAM,CAAC;IAC3B;;;OAGG;IACI,OAAO,CAAC,EAAE,eAAe,CAAC;IACjC;;;OAGG;IACI,QAAQ,CAAC,EAAE,gBAAgB,CAAC;IACnC;;OAEG;IACI,OAAO,CAAC,EAAE,OAAO,CAAC;gBAEb,OAAO,EAAE,MAAM,EAAE,OAAO,GAAE,gBAAqB;CA4B5D;AAED;;;GAGG;AACH,wBAAgB,WAAW,CAAC,CAAC,EAAE,OAAO,GAAG,CAAC,IAAI,SAAS,CAKtD"} \ No newline at end of file diff --git a/node_modules/@azure/core-rest-pipeline/dist/browser/util/file.d.ts.map b/node_modules/@azure/core-rest-pipeline/dist/browser/util/file.d.ts.map index 092797aa..d165dbda 100644 --- a/node_modules/@azure/core-rest-pipeline/dist/browser/util/file.d.ts.map +++ b/node_modules/@azure/core-rest-pipeline/dist/browser/util/file.d.ts.map @@ -1 +1 @@ -{"version":3,"file":"file.d.ts","sourceRoot":"","sources":["../../../src/util/file.ts"],"names":[],"mappings":"AAMA;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAC7B;AAED;;GAEG;AACH,MAAM,WAAW,2BAA4B,SAAQ,iBAAiB;IACpE;;;;;OAKG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAyCD;;;;;;GAMG;AACH,wBAAgB,aAAa,CAC3B,IAAI,EAAE,IAAI,GACT,MAAM,CAAC,cAAc,GAAG,cAAc,CAAC,UAAU,CAAC,GAAG,UAAU,CAMjE;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,oBAAoB,CAClC,MAAM,EAAE,MAAM,cAAc,CAAC,UAAU,CAAC,GAAG,MAAM,CAAC,cAAc,EAChE,IAAI,EAAE,MAAM,EACZ,OAAO,GAAE,2BAAgC,GACxC,IAAI,CAoBN;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,UAAU,CACxB,OAAO,EAAE,UAAU,EACnB,IAAI,EAAE,MAAM,EACZ,OAAO,GAAE,iBAAsB,GAC9B,IAAI,CAgBN"} \ No newline at end of file +{"version":3,"file":"file.d.ts","sourceRoot":"","sources":["../../../src/util/file.ts"],"names":[],"mappings":"AAMA;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAC7B;AAED;;GAEG;AACH,MAAM,WAAW,2BAA4B,SAAQ,iBAAiB;IACpE;;;;;OAKG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AA4CD;;;;;;GAMG;AACH,wBAAgB,aAAa,CAC3B,IAAI,EAAE,IAAI,GACT,MAAM,CAAC,cAAc,GAAG,cAAc,CAAC,UAAU,CAAC,GAAG,UAAU,CAMjE;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,oBAAoB,CAClC,MAAM,EAAE,MAAM,cAAc,CAAC,UAAU,CAAC,GAAG,MAAM,CAAC,cAAc,EAChE,IAAI,EAAE,MAAM,EACZ,OAAO,GAAE,2BAAgC,GACxC,IAAI,CAoBN;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,UAAU,CACxB,OAAO,EAAE,UAAU,EACnB,IAAI,EAAE,MAAM,EACZ,OAAO,GAAE,iBAAsB,GAC9B,IAAI,CAgBN"} \ No newline at end of file diff --git a/node_modules/@azure/core-rest-pipeline/dist/browser/util/file.js b/node_modules/@azure/core-rest-pipeline/dist/browser/util/file.js index a9af2dc5..0a26caa1 100644 --- a/node_modules/@azure/core-rest-pipeline/dist/browser/util/file.js +++ b/node_modules/@azure/core-rest-pipeline/dist/browser/util/file.js @@ -6,6 +6,9 @@ const unimplementedMethods = { arrayBuffer: () => { throw new Error("Not implemented"); }, + bytes: () => { + throw new Error("Not implemented"); + }, slice: () => { throw new Error("Not implemented"); }, diff --git a/node_modules/@azure/core-rest-pipeline/dist/browser/util/file.js.map b/node_modules/@azure/core-rest-pipeline/dist/browser/util/file.js.map index 87721d1a..05a0c7da 100644 --- a/node_modules/@azure/core-rest-pipeline/dist/browser/util/file.js.map +++ b/node_modules/@azure/core-rest-pipeline/dist/browser/util/file.js.map @@ -1 +1 @@ -{"version":3,"file":"file.js","sourceRoot":"","sources":["../../../src/util/file.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAElC,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAC9C,OAAO,EAAE,oBAAoB,EAAE,MAAM,iBAAiB,CAAC;AAoCvD,MAAM,oBAAoB,GAAG;IAC3B,WAAW,EAAE,GAAG,EAAE;QAChB,MAAM,IAAI,KAAK,CAAC,iBAAiB,CAAC,CAAC;IACrC,CAAC;IACD,KAAK,EAAE,GAAG,EAAE;QACV,MAAM,IAAI,KAAK,CAAC,iBAAiB,CAAC,CAAC;IACrC,CAAC;IACD,IAAI,EAAE,GAAG,EAAE;QACT,MAAM,IAAI,KAAK,CAAC,iBAAiB,CAAC,CAAC;IACrC,CAAC;CACF,CAAC;AAEF;;;;;;;;;;;;;GAaG;AACH,MAAM,UAAU,GAAkB,MAAM,CAAC,YAAY,CAAC,CAAC;AASvD,SAAS,aAAa,CAAC,CAAU;IAC/B,OAAO,OAAQ,CAAgB,CAAC,UAAU,CAAC,KAAK,UAAU,CAAC;AAC7D,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,aAAa,CAC3B,IAAU;IAEV,IAAI,aAAa,CAAC,IAAI,CAAC,EAAE,CAAC;QACxB,OAAO,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC;IAC5B,CAAC;SAAM,CAAC;QACN,OAAO,IAAI,CAAC,MAAM,EAAE,CAAC;IACvB,CAAC;AACH,CAAC;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,UAAU,oBAAoB,CAClC,MAAgE,EAChE,IAAY,EACZ,UAAuC,EAAE;;IAEzC,OAAO,gCACF,oBAAoB,KACvB,IAAI,EAAE,MAAA,OAAO,CAAC,IAAI,mCAAI,EAAE,EACxB,YAAY,EAAE,MAAA,OAAO,CAAC,YAAY,mCAAI,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,EAC1D,kBAAkB,EAAE,MAAA,OAAO,CAAC,kBAAkB,mCAAI,EAAE,EACpD,IAAI,EAAE,MAAA,OAAO,CAAC,IAAI,mCAAI,CAAC,CAAC,EACxB,IAAI,EACJ,MAAM,EAAE,GAAG,EAAE;YACX,MAAM,CAAC,GAAG,MAAM,EAAE,CAAC;YACnB,IAAI,oBAAoB,CAAC,CAAC,CAAC,EAAE,CAAC;gBAC5B,MAAM,IAAI,KAAK,CACb,6EAA6E,CAC9E,CAAC;YACJ,CAAC;YAED,OAAO,CAAC,CAAC;QACX,CAAC,EACD,CAAC,UAAU,CAAC,EAAE,MAAM,GACA,CAAC;AACzB,CAAC;AAED;;;;;;;;;;GAUG;AACH,MAAM,UAAU,UAAU,CACxB,OAAmB,EACnB,IAAY,EACZ,UAA6B,EAAE;;IAE/B,IAAI,UAAU,EAAE,CAAC;QACf,OAAO,gCACF,oBAAoB,KACvB,IAAI,EAAE,MAAA,OAAO,CAAC,IAAI,mCAAI,EAAE,EACxB,YAAY,EAAE,MAAA,OAAO,CAAC,YAAY,mCAAI,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,EAC1D,kBAAkB,EAAE,MAAA,OAAO,CAAC,kBAAkB,mCAAI,EAAE,EACpD,IAAI,EAAE,OAAO,CAAC,UAAU,EACxB,IAAI,EACJ,WAAW,EAAE,KAAK,IAAI,EAAE,CAAC,OAAO,CAAC,MAAM,EACvC,MAAM,EAAE,GAAG,EAAE,CAAC,IAAI,IAAI,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,EAAE,EAC1C,CAAC,UAAU,CAAC,EAAE,GAAG,EAAE,CAAC,OAAO,GACP,CAAC;IACzB,CAAC;SAAM,CAAC;QACN,OAAO,IAAI,IAAI,CAAC,CAAC,OAAO,CAAC,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;IAC5C,CAAC;AACH,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport { isNodeLike } from \"@azure/core-util\";\nimport { isNodeReadableStream } from \"./typeGuards.js\";\n\n/**\n * Options passed into createFile specifying metadata about the file.\n */\nexport interface CreateFileOptions {\n /**\n * The MIME type of the file.\n */\n type?: string;\n\n /**\n * Last modified time of the file as a UNIX timestamp.\n * This will default to the current date.\n */\n lastModified?: number;\n\n /**\n * relative path of this file when uploading a directory.\n */\n webkitRelativePath?: string;\n}\n\n/**\n * Extra options for createFile when a stream is being passed in.\n */\nexport interface CreateFileFromStreamOptions extends CreateFileOptions {\n /**\n * Size of the file represented by the stream in bytes.\n *\n * This will be used by the pipeline when calculating the Content-Length header\n * for the overall request.\n */\n size?: number;\n}\n\nconst unimplementedMethods = {\n arrayBuffer: () => {\n throw new Error(\"Not implemented\");\n },\n slice: () => {\n throw new Error(\"Not implemented\");\n },\n text: () => {\n throw new Error(\"Not implemented\");\n },\n};\n\n/**\n * Private symbol used as key on objects created using createFile containing the\n * original source of the file object.\n *\n * This is used in Node to access the original Node stream without using Blob#stream, which\n * returns a web stream. This is done to avoid a couple of bugs to do with Blob#stream and\n * Readable#to/fromWeb in Node versions we support:\n * - https://github.com/nodejs/node/issues/42694 (fixed in Node 18.14)\n * - https://github.com/nodejs/node/issues/48916 (fixed in Node 20.6)\n *\n * Once these versions are no longer supported, we may be able to stop doing this.\n *\n * @internal\n */\nconst rawContent: unique symbol = Symbol(\"rawContent\");\n\n/**\n * Type signature of a blob-like object with a raw content property.\n */\ninterface RawContent {\n [rawContent](): Uint8Array | NodeJS.ReadableStream | ReadableStream;\n}\n\nfunction hasRawContent(x: unknown): x is RawContent {\n return typeof (x as RawContent)[rawContent] === \"function\";\n}\n\n/**\n * Extract the raw content from a given blob-like object. If the input was created using createFile\n * or createFileFromStream, the exact content passed into createFile/createFileFromStream will be used.\n * For true instances of Blob and File, returns the blob's content as a Web ReadableStream.\n *\n * @internal\n */\nexport function getRawContent(\n blob: Blob,\n): NodeJS.ReadableStream | ReadableStream | Uint8Array {\n if (hasRawContent(blob)) {\n return blob[rawContent]();\n } else {\n return blob.stream();\n }\n}\n\n/**\n * Create an object that implements the File interface. This object is intended to be\n * passed into RequestBodyType.formData, and is not guaranteed to work as expected in\n * other situations.\n *\n * Use this function to:\n * - Create a File object for use in RequestBodyType.formData in environments where the\n * global File object is unavailable.\n * - Create a File-like object from a readable stream without reading the stream into memory.\n *\n * @param stream - the content of the file as a callback returning a stream. When a File object made using createFile is\n * passed in a request's form data map, the stream will not be read into memory\n * and instead will be streamed when the request is made. In the event of a retry, the\n * stream needs to be read again, so this callback SHOULD return a fresh stream if possible.\n * @param name - the name of the file.\n * @param options - optional metadata about the file, e.g. file name, file size, MIME type.\n */\nexport function createFileFromStream(\n stream: () => ReadableStream | NodeJS.ReadableStream,\n name: string,\n options: CreateFileFromStreamOptions = {},\n): File {\n return {\n ...unimplementedMethods,\n type: options.type ?? \"\",\n lastModified: options.lastModified ?? new Date().getTime(),\n webkitRelativePath: options.webkitRelativePath ?? \"\",\n size: options.size ?? -1,\n name,\n stream: () => {\n const s = stream();\n if (isNodeReadableStream(s)) {\n throw new Error(\n \"Not supported: a Node stream was provided as input to createFileFromStream.\",\n );\n }\n\n return s;\n },\n [rawContent]: stream,\n } as File & RawContent;\n}\n\n/**\n * Create an object that implements the File interface. This object is intended to be\n * passed into RequestBodyType.formData, and is not guaranteed to work as expected in\n * other situations.\n *\n * Use this function create a File object for use in RequestBodyType.formData in environments where the global File object is unavailable.\n *\n * @param content - the content of the file as a Uint8Array in memory.\n * @param name - the name of the file.\n * @param options - optional metadata about the file, e.g. file name, file size, MIME type.\n */\nexport function createFile(\n content: Uint8Array,\n name: string,\n options: CreateFileOptions = {},\n): File {\n if (isNodeLike) {\n return {\n ...unimplementedMethods,\n type: options.type ?? \"\",\n lastModified: options.lastModified ?? new Date().getTime(),\n webkitRelativePath: options.webkitRelativePath ?? \"\",\n size: content.byteLength,\n name,\n arrayBuffer: async () => content.buffer,\n stream: () => new Blob([content]).stream(),\n [rawContent]: () => content,\n } as File & RawContent;\n } else {\n return new File([content], name, options);\n }\n}\n"]} \ No newline at end of file +{"version":3,"file":"file.js","sourceRoot":"","sources":["../../../src/util/file.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAElC,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAC9C,OAAO,EAAE,oBAAoB,EAAE,MAAM,iBAAiB,CAAC;AAoCvD,MAAM,oBAAoB,GAAG;IAC3B,WAAW,EAAE,GAAG,EAAE;QAChB,MAAM,IAAI,KAAK,CAAC,iBAAiB,CAAC,CAAC;IACrC,CAAC;IACD,KAAK,EAAE,GAAG,EAAE;QACV,MAAM,IAAI,KAAK,CAAC,iBAAiB,CAAC,CAAC;IACrC,CAAC;IACD,KAAK,EAAE,GAAG,EAAE;QACV,MAAM,IAAI,KAAK,CAAC,iBAAiB,CAAC,CAAC;IACrC,CAAC;IACD,IAAI,EAAE,GAAG,EAAE;QACT,MAAM,IAAI,KAAK,CAAC,iBAAiB,CAAC,CAAC;IACrC,CAAC;CACF,CAAC;AAEF;;;;;;;;;;;;;GAaG;AACH,MAAM,UAAU,GAAkB,MAAM,CAAC,YAAY,CAAC,CAAC;AASvD,SAAS,aAAa,CAAC,CAAU;IAC/B,OAAO,OAAQ,CAAgB,CAAC,UAAU,CAAC,KAAK,UAAU,CAAC;AAC7D,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,aAAa,CAC3B,IAAU;IAEV,IAAI,aAAa,CAAC,IAAI,CAAC,EAAE,CAAC;QACxB,OAAO,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC;IAC5B,CAAC;SAAM,CAAC;QACN,OAAO,IAAI,CAAC,MAAM,EAAE,CAAC;IACvB,CAAC;AACH,CAAC;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,UAAU,oBAAoB,CAClC,MAAgE,EAChE,IAAY,EACZ,UAAuC,EAAE;;IAEzC,OAAO,gCACF,oBAAoB,KACvB,IAAI,EAAE,MAAA,OAAO,CAAC,IAAI,mCAAI,EAAE,EACxB,YAAY,EAAE,MAAA,OAAO,CAAC,YAAY,mCAAI,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,EAC1D,kBAAkB,EAAE,MAAA,OAAO,CAAC,kBAAkB,mCAAI,EAAE,EACpD,IAAI,EAAE,MAAA,OAAO,CAAC,IAAI,mCAAI,CAAC,CAAC,EACxB,IAAI,EACJ,MAAM,EAAE,GAAG,EAAE;YACX,MAAM,CAAC,GAAG,MAAM,EAAE,CAAC;YACnB,IAAI,oBAAoB,CAAC,CAAC,CAAC,EAAE,CAAC;gBAC5B,MAAM,IAAI,KAAK,CACb,6EAA6E,CAC9E,CAAC;YACJ,CAAC;YAED,OAAO,CAAC,CAAC;QACX,CAAC,EACD,CAAC,UAAU,CAAC,EAAE,MAAM,GACA,CAAC;AACzB,CAAC;AAED;;;;;;;;;;GAUG;AACH,MAAM,UAAU,UAAU,CACxB,OAAmB,EACnB,IAAY,EACZ,UAA6B,EAAE;;IAE/B,IAAI,UAAU,EAAE,CAAC;QACf,OAAO,gCACF,oBAAoB,KACvB,IAAI,EAAE,MAAA,OAAO,CAAC,IAAI,mCAAI,EAAE,EACxB,YAAY,EAAE,MAAA,OAAO,CAAC,YAAY,mCAAI,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,EAC1D,kBAAkB,EAAE,MAAA,OAAO,CAAC,kBAAkB,mCAAI,EAAE,EACpD,IAAI,EAAE,OAAO,CAAC,UAAU,EACxB,IAAI,EACJ,WAAW,EAAE,KAAK,IAAI,EAAE,CAAC,OAAO,CAAC,MAAM,EACvC,MAAM,EAAE,GAAG,EAAE,CAAC,IAAI,IAAI,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,EAAE,EAC1C,CAAC,UAAU,CAAC,EAAE,GAAG,EAAE,CAAC,OAAO,GACP,CAAC;IACzB,CAAC;SAAM,CAAC;QACN,OAAO,IAAI,IAAI,CAAC,CAAC,OAAO,CAAC,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;IAC5C,CAAC;AACH,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport { isNodeLike } from \"@azure/core-util\";\nimport { isNodeReadableStream } from \"./typeGuards.js\";\n\n/**\n * Options passed into createFile specifying metadata about the file.\n */\nexport interface CreateFileOptions {\n /**\n * The MIME type of the file.\n */\n type?: string;\n\n /**\n * Last modified time of the file as a UNIX timestamp.\n * This will default to the current date.\n */\n lastModified?: number;\n\n /**\n * relative path of this file when uploading a directory.\n */\n webkitRelativePath?: string;\n}\n\n/**\n * Extra options for createFile when a stream is being passed in.\n */\nexport interface CreateFileFromStreamOptions extends CreateFileOptions {\n /**\n * Size of the file represented by the stream in bytes.\n *\n * This will be used by the pipeline when calculating the Content-Length header\n * for the overall request.\n */\n size?: number;\n}\n\nconst unimplementedMethods = {\n arrayBuffer: () => {\n throw new Error(\"Not implemented\");\n },\n bytes: () => {\n throw new Error(\"Not implemented\");\n },\n slice: () => {\n throw new Error(\"Not implemented\");\n },\n text: () => {\n throw new Error(\"Not implemented\");\n },\n};\n\n/**\n * Private symbol used as key on objects created using createFile containing the\n * original source of the file object.\n *\n * This is used in Node to access the original Node stream without using Blob#stream, which\n * returns a web stream. This is done to avoid a couple of bugs to do with Blob#stream and\n * Readable#to/fromWeb in Node versions we support:\n * - https://github.com/nodejs/node/issues/42694 (fixed in Node 18.14)\n * - https://github.com/nodejs/node/issues/48916 (fixed in Node 20.6)\n *\n * Once these versions are no longer supported, we may be able to stop doing this.\n *\n * @internal\n */\nconst rawContent: unique symbol = Symbol(\"rawContent\");\n\n/**\n * Type signature of a blob-like object with a raw content property.\n */\ninterface RawContent {\n [rawContent](): Uint8Array | NodeJS.ReadableStream | ReadableStream;\n}\n\nfunction hasRawContent(x: unknown): x is RawContent {\n return typeof (x as RawContent)[rawContent] === \"function\";\n}\n\n/**\n * Extract the raw content from a given blob-like object. If the input was created using createFile\n * or createFileFromStream, the exact content passed into createFile/createFileFromStream will be used.\n * For true instances of Blob and File, returns the blob's content as a Web ReadableStream.\n *\n * @internal\n */\nexport function getRawContent(\n blob: Blob,\n): NodeJS.ReadableStream | ReadableStream | Uint8Array {\n if (hasRawContent(blob)) {\n return blob[rawContent]();\n } else {\n return blob.stream();\n }\n}\n\n/**\n * Create an object that implements the File interface. This object is intended to be\n * passed into RequestBodyType.formData, and is not guaranteed to work as expected in\n * other situations.\n *\n * Use this function to:\n * - Create a File object for use in RequestBodyType.formData in environments where the\n * global File object is unavailable.\n * - Create a File-like object from a readable stream without reading the stream into memory.\n *\n * @param stream - the content of the file as a callback returning a stream. When a File object made using createFile is\n * passed in a request's form data map, the stream will not be read into memory\n * and instead will be streamed when the request is made. In the event of a retry, the\n * stream needs to be read again, so this callback SHOULD return a fresh stream if possible.\n * @param name - the name of the file.\n * @param options - optional metadata about the file, e.g. file name, file size, MIME type.\n */\nexport function createFileFromStream(\n stream: () => ReadableStream | NodeJS.ReadableStream,\n name: string,\n options: CreateFileFromStreamOptions = {},\n): File {\n return {\n ...unimplementedMethods,\n type: options.type ?? \"\",\n lastModified: options.lastModified ?? new Date().getTime(),\n webkitRelativePath: options.webkitRelativePath ?? \"\",\n size: options.size ?? -1,\n name,\n stream: () => {\n const s = stream();\n if (isNodeReadableStream(s)) {\n throw new Error(\n \"Not supported: a Node stream was provided as input to createFileFromStream.\",\n );\n }\n\n return s;\n },\n [rawContent]: stream,\n } as File & RawContent;\n}\n\n/**\n * Create an object that implements the File interface. This object is intended to be\n * passed into RequestBodyType.formData, and is not guaranteed to work as expected in\n * other situations.\n *\n * Use this function create a File object for use in RequestBodyType.formData in environments where the global File object is unavailable.\n *\n * @param content - the content of the file as a Uint8Array in memory.\n * @param name - the name of the file.\n * @param options - optional metadata about the file, e.g. file name, file size, MIME type.\n */\nexport function createFile(\n content: Uint8Array,\n name: string,\n options: CreateFileOptions = {},\n): File {\n if (isNodeLike) {\n return {\n ...unimplementedMethods,\n type: options.type ?? \"\",\n lastModified: options.lastModified ?? new Date().getTime(),\n webkitRelativePath: options.webkitRelativePath ?? \"\",\n size: content.byteLength,\n name,\n arrayBuffer: async () => content.buffer,\n stream: () => new Blob([content]).stream(),\n [rawContent]: () => content,\n } as File & RawContent;\n } else {\n return new File([content], name, options);\n }\n}\n"]} \ No newline at end of file diff --git a/node_modules/@azure/core-rest-pipeline/dist/commonjs/constants.js b/node_modules/@azure/core-rest-pipeline/dist/commonjs/constants.js index 6587dd66..23bd611c 100644 --- a/node_modules/@azure/core-rest-pipeline/dist/commonjs/constants.js +++ b/node_modules/@azure/core-rest-pipeline/dist/commonjs/constants.js @@ -3,6 +3,6 @@ // Licensed under the MIT License. Object.defineProperty(exports, "__esModule", { value: true }); exports.DEFAULT_RETRY_POLICY_COUNT = exports.SDK_VERSION = void 0; -exports.SDK_VERSION = "1.18.1"; +exports.SDK_VERSION = "1.18.2"; exports.DEFAULT_RETRY_POLICY_COUNT = 3; //# sourceMappingURL=constants.js.map \ No newline at end of file diff --git a/node_modules/@azure/core-rest-pipeline/dist/commonjs/constants.js.map b/node_modules/@azure/core-rest-pipeline/dist/commonjs/constants.js.map index 2732820c..eb35c182 100644 --- a/node_modules/@azure/core-rest-pipeline/dist/commonjs/constants.js.map +++ b/node_modules/@azure/core-rest-pipeline/dist/commonjs/constants.js.map @@ -1 +1 @@ -{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../src/constants.ts"],"names":[],"mappings":";AAAA,uCAAuC;AACvC,kCAAkC;;;AAErB,QAAA,WAAW,GAAW,QAAQ,CAAC;AAE/B,QAAA,0BAA0B,GAAG,CAAC,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nexport const SDK_VERSION: string = \"1.18.1\";\n\nexport const DEFAULT_RETRY_POLICY_COUNT = 3;\n"]} \ No newline at end of file +{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../src/constants.ts"],"names":[],"mappings":";AAAA,uCAAuC;AACvC,kCAAkC;;;AAErB,QAAA,WAAW,GAAW,QAAQ,CAAC;AAE/B,QAAA,0BAA0B,GAAG,CAAC,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nexport const SDK_VERSION: string = \"1.18.2\";\n\nexport const DEFAULT_RETRY_POLICY_COUNT = 3;\n"]} \ No newline at end of file diff --git a/node_modules/@azure/core-rest-pipeline/dist/commonjs/index.d.ts.map b/node_modules/@azure/core-rest-pipeline/dist/commonjs/index.d.ts.map index f8bb1e79..1f8d8a55 100644 --- a/node_modules/@azure/core-rest-pipeline/dist/commonjs/index.d.ts.map +++ b/node_modules/@azure/core-rest-pipeline/dist/commonjs/index.d.ts.map @@ -1 +1 @@ -{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAIA,OAAO,CAAC,MAAM,CAAC;IACb,UAAU,QAAQ;KAAG;IACrB,UAAU,IAAI;KAAG;IACjB,UAAU,IAAI;KAAG;IACjB,UAAU,cAAc,CAAC,CAAC,GAAG,GAAG;KAAI;IACpC,UAAU,eAAe,CAAC,CAAC,GAAG,GAAG,EAAE,CAAC,GAAG,GAAG;KAAI;CAC/C;AAGD,YAAY,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AACpD,YAAY,EACV,KAAK,EACL,QAAQ,EACR,WAAW,EACX,aAAa,EACb,UAAU,EACV,WAAW,EACX,SAAS,EACT,oBAAoB,EACpB,eAAe,EACf,gBAAgB,EAChB,oBAAoB,EACpB,aAAa,EACb,SAAS,EACT,cAAc,EACd,mBAAmB,EACnB,eAAe,EACf,WAAW,EACX,WAAW,EACX,qBAAqB,GACtB,MAAM,iBAAiB,CAAC;AACzB,OAAO,EACL,KAAK,gBAAgB,IAAI,kBAAkB,EAC3C,KAAK,aAAa,EAClB,KAAK,cAAc,EACnB,KAAK,QAAQ,EACb,mBAAmB,GACpB,MAAM,eAAe,CAAC;AACvB,OAAO,EACL,yBAAyB,EACzB,KAAK,gBAAgB,EACrB,KAAK,uBAAuB,EAC5B,KAAK,eAAe,GACrB,MAAM,gCAAgC,CAAC;AACxC,OAAO,EAAE,uBAAuB,EAAE,MAAM,wBAAwB,CAAC;AACjE,OAAO,EAAE,iBAAiB,EAAE,MAAM,kBAAkB,CAAC;AACrD,OAAO,EAAE,qBAAqB,EAAE,KAAK,sBAAsB,EAAE,MAAM,sBAAsB,CAAC;AAC1F,OAAO,EAAE,SAAS,EAAE,KAAK,gBAAgB,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAC/E,OAAO,EACL,wBAAwB,EACxB,4BAA4B,GAC7B,MAAM,wCAAwC,CAAC;AAChD,OAAO,EACL,sBAAsB,EACtB,KAAK,6BAA6B,EAClC,0BAA0B,GAC3B,MAAM,sCAAsC,CAAC;AAC9C,OAAO,EACL,wBAAwB,EACxB,4BAA4B,GAC7B,MAAM,wCAAwC,CAAC;AAChD,OAAO,EAAE,SAAS,EAAE,aAAa,EAAE,KAAK,gBAAgB,EAAE,MAAM,yBAAyB,CAAC;AAC1F,OAAO,EAAE,eAAe,EAAE,mBAAmB,EAAE,MAAM,+BAA+B,CAAC;AACrF,OAAO,EAAE,WAAW,EAAE,eAAe,EAAE,uBAAuB,EAAE,MAAM,2BAA2B,CAAC;AAClG,OAAO,EACL,cAAc,EACd,kBAAkB,EAClB,KAAK,qBAAqB,GAC3B,MAAM,8BAA8B,CAAC;AACtC,OAAO,EACL,sBAAsB,EACtB,KAAK,6BAA6B,EAClC,0BAA0B,GAC3B,MAAM,sCAAsC,CAAC;AAC9C,OAAO,EACL,qBAAqB,EACrB,yBAAyB,EACzB,KAAK,4BAA4B,GAClC,MAAM,qCAAqC,CAAC;AAC7C,OAAO,EAAE,WAAW,EAAE,KAAK,kBAAkB,EAAE,MAAM,2BAA2B,CAAC;AACjF,YAAY,EACV,aAAa,EACb,gBAAgB,EAChB,cAAc,GACf,MAAM,oCAAoC,CAAC;AAC5C,OAAO,EACL,aAAa,EACb,iBAAiB,EACjB,KAAK,oBAAoB,GAC1B,MAAM,6BAA6B,CAAC;AACrC,OAAO,EACL,kBAAkB,EAClB,KAAK,yBAAyB,GAC/B,MAAM,kCAAkC,CAAC;AAC1C,OAAO,EACL,eAAe,EACf,mBAAmB,EACnB,KAAK,sBAAsB,GAC5B,MAAM,+BAA+B,CAAC;AACvC,OAAO,EAAE,SAAS,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAC;AACnE,OAAO,EAAE,cAAc,EAAE,kBAAkB,EAAE,MAAM,8BAA8B,CAAC;AAClF,OAAO,EACL,+BAA+B,EAC/B,KAAK,sCAAsC,EAC3C,mCAAmC,EACnC,KAAK,kBAAkB,EACvB,KAAK,uBAAuB,EAC5B,KAAK,kCAAkC,GACxC,MAAM,+CAA+C,CAAC;AACvD,OAAO,EAAE,YAAY,EAAE,gBAAgB,EAAE,MAAM,4BAA4B,CAAC;AAC5E,OAAO,EACL,mCAAmC,EACnC,KAAK,0CAA0C,EAC/C,uCAAuC,GACxC,MAAM,mDAAmD,CAAC;AAC3D,OAAO,EACL,UAAU,EACV,oBAAoB,EACpB,KAAK,iBAAiB,EACtB,KAAK,2BAA2B,GACjC,MAAM,gBAAgB,CAAC"} \ No newline at end of file +{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAGA,OAAO,CAAC,MAAM,CAAC;IACb,UAAU,QAAQ;KAAG;IACrB,UAAU,IAAI;KAAG;IACjB,UAAU,IAAI;KAAG;IACjB,UAAU,cAAc,CAAC,CAAC,GAAG,GAAG;KAAI;IACpC,UAAU,eAAe,CAAC,CAAC,GAAG,GAAG,EAAE,CAAC,GAAG,GAAG;KAAI;CAC/C;AAED,YAAY,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AACpD,YAAY,EACV,KAAK,EACL,QAAQ,EACR,WAAW,EACX,aAAa,EACb,UAAU,EACV,WAAW,EACX,SAAS,EACT,oBAAoB,EACpB,eAAe,EACf,gBAAgB,EAChB,oBAAoB,EACpB,aAAa,EACb,SAAS,EACT,cAAc,EACd,mBAAmB,EACnB,eAAe,EACf,WAAW,EACX,WAAW,EACX,qBAAqB,GACtB,MAAM,iBAAiB,CAAC;AACzB,OAAO,EACL,KAAK,gBAAgB,IAAI,kBAAkB,EAC3C,KAAK,aAAa,EAClB,KAAK,cAAc,EACnB,KAAK,QAAQ,EACb,mBAAmB,GACpB,MAAM,eAAe,CAAC;AACvB,OAAO,EACL,yBAAyB,EACzB,KAAK,gBAAgB,EACrB,KAAK,uBAAuB,EAC5B,KAAK,eAAe,GACrB,MAAM,gCAAgC,CAAC;AACxC,OAAO,EAAE,uBAAuB,EAAE,MAAM,wBAAwB,CAAC;AACjE,OAAO,EAAE,iBAAiB,EAAE,MAAM,kBAAkB,CAAC;AACrD,OAAO,EAAE,qBAAqB,EAAE,KAAK,sBAAsB,EAAE,MAAM,sBAAsB,CAAC;AAC1F,OAAO,EAAE,SAAS,EAAE,KAAK,gBAAgB,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAC/E,OAAO,EACL,wBAAwB,EACxB,4BAA4B,GAC7B,MAAM,wCAAwC,CAAC;AAChD,OAAO,EACL,sBAAsB,EACtB,KAAK,6BAA6B,EAClC,0BAA0B,GAC3B,MAAM,sCAAsC,CAAC;AAC9C,OAAO,EACL,wBAAwB,EACxB,4BAA4B,GAC7B,MAAM,wCAAwC,CAAC;AAChD,OAAO,EAAE,SAAS,EAAE,aAAa,EAAE,KAAK,gBAAgB,EAAE,MAAM,yBAAyB,CAAC;AAC1F,OAAO,EAAE,eAAe,EAAE,mBAAmB,EAAE,MAAM,+BAA+B,CAAC;AACrF,OAAO,EAAE,WAAW,EAAE,eAAe,EAAE,uBAAuB,EAAE,MAAM,2BAA2B,CAAC;AAClG,OAAO,EACL,cAAc,EACd,kBAAkB,EAClB,KAAK,qBAAqB,GAC3B,MAAM,8BAA8B,CAAC;AACtC,OAAO,EACL,sBAAsB,EACtB,KAAK,6BAA6B,EAClC,0BAA0B,GAC3B,MAAM,sCAAsC,CAAC;AAC9C,OAAO,EACL,qBAAqB,EACrB,yBAAyB,EACzB,KAAK,4BAA4B,GAClC,MAAM,qCAAqC,CAAC;AAC7C,OAAO,EAAE,WAAW,EAAE,KAAK,kBAAkB,EAAE,MAAM,2BAA2B,CAAC;AACjF,YAAY,EACV,aAAa,EACb,gBAAgB,EAChB,cAAc,GACf,MAAM,oCAAoC,CAAC;AAC5C,OAAO,EACL,aAAa,EACb,iBAAiB,EACjB,KAAK,oBAAoB,GAC1B,MAAM,6BAA6B,CAAC;AACrC,OAAO,EACL,kBAAkB,EAClB,KAAK,yBAAyB,GAC/B,MAAM,kCAAkC,CAAC;AAC1C,OAAO,EACL,eAAe,EACf,mBAAmB,EACnB,KAAK,sBAAsB,GAC5B,MAAM,+BAA+B,CAAC;AACvC,OAAO,EAAE,SAAS,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAC;AACnE,OAAO,EAAE,cAAc,EAAE,kBAAkB,EAAE,MAAM,8BAA8B,CAAC;AAClF,OAAO,EACL,+BAA+B,EAC/B,KAAK,sCAAsC,EAC3C,mCAAmC,EACnC,KAAK,kBAAkB,EACvB,KAAK,uBAAuB,EAC5B,KAAK,kCAAkC,GACxC,MAAM,+CAA+C,CAAC;AACvD,OAAO,EAAE,YAAY,EAAE,gBAAgB,EAAE,MAAM,4BAA4B,CAAC;AAC5E,OAAO,EACL,mCAAmC,EACnC,KAAK,0CAA0C,EAC/C,uCAAuC,GACxC,MAAM,mDAAmD,CAAC;AAC3D,OAAO,EACL,UAAU,EACV,oBAAoB,EACpB,KAAK,iBAAiB,EACtB,KAAK,2BAA2B,GACjC,MAAM,gBAAgB,CAAC"} \ No newline at end of file diff --git a/node_modules/@azure/core-rest-pipeline/dist/commonjs/index.js.map b/node_modules/@azure/core-rest-pipeline/dist/commonjs/index.js.map index 7a4a4ac8..b1e79158 100644 --- a/node_modules/@azure/core-rest-pipeline/dist/commonjs/index.js.map +++ b/node_modules/@azure/core-rest-pipeline/dist/commonjs/index.js.map @@ -1 +1 @@ -{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";AAAA,uCAAuC;AACvC,kCAAkC;;;AAkClC,6CAMuB;AADrB,kHAAA,mBAAmB,OAAA;AAErB,+EAKwC;AAJtC,yIAAA,yBAAyB,OAAA;AAK3B,+DAAiE;AAAxD,+HAAA,uBAAuB,OAAA;AAChC,mDAAqD;AAA5C,mHAAA,iBAAiB,OAAA;AAC1B,2DAA0F;AAAjF,2HAAA,qBAAqB,OAAA;AAC9B,+CAA+E;AAAtE,yGAAA,SAAS,OAAA;AAAyB,2GAAA,WAAW,OAAA;AACtD,sFAGgD;AAF9C,uIAAA,wBAAwB,OAAA;AACxB,2IAAA,4BAA4B,OAAA;AAE9B,kFAI8C;AAH5C,mIAAA,sBAAsB,OAAA;AAEtB,uIAAA,0BAA0B,OAAA;AAE5B,sFAGgD;AAF9C,uIAAA,wBAAwB,OAAA;AACxB,2IAAA,4BAA4B,OAAA;AAE9B,wDAA0F;AAAjF,yGAAA,SAAS,OAAA;AAAE,6GAAA,aAAa,OAAA;AACjC,oEAAqF;AAA5E,qHAAA,eAAe,OAAA;AAAE,yHAAA,mBAAmB,OAAA;AAC7C,4DAAkG;AAAzF,6GAAA,WAAW,OAAA;AAAE,iHAAA,eAAe,OAAA;AAAE,yHAAA,uBAAuB,OAAA;AAC9D,kEAIsC;AAHpC,mHAAA,cAAc,OAAA;AACd,uHAAA,kBAAkB,OAAA;AAGpB,kFAI8C;AAH5C,mIAAA,sBAAsB,OAAA;AAEtB,uIAAA,0BAA0B,OAAA;AAE5B,gFAI6C;AAH3C,iIAAA,qBAAqB,OAAA;AACrB,qIAAA,yBAAyB,OAAA;AAG3B,4DAAiF;AAAxE,6GAAA,WAAW,OAAA;AAMpB,gEAIqC;AAHnC,iHAAA,aAAa,OAAA;AACb,qHAAA,iBAAiB,OAAA;AAGnB,0EAG0C;AAFxC,2HAAA,kBAAkB,OAAA;AAGpB,oEAIuC;AAHrC,qHAAA,eAAe,OAAA;AACf,yHAAA,mBAAmB,OAAA;AAGrB,wDAAmE;AAA1D,yGAAA,SAAS,OAAA;AAAE,6GAAA,aAAa,OAAA;AACjC,kEAAkF;AAAzE,mHAAA,cAAc,OAAA;AAAE,uHAAA,kBAAkB,OAAA;AAC3C,oGAOuD;AANrD,qJAAA,+BAA+B,OAAA;AAE/B,yJAAA,mCAAmC,OAAA;AAKrC,8DAA4E;AAAnE,+GAAA,YAAY,OAAA;AAAE,mHAAA,gBAAgB,OAAA;AACvC,4GAI2D;AAHzD,6JAAA,mCAAmC,OAAA;AAEnC,iKAAA,uCAAuC,OAAA;AAEzC,0CAKwB;AAJtB,qGAAA,UAAU,OAAA;AACV,+GAAA,oBAAoB,OAAA","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\n/* eslint-disable @typescript-eslint/no-unused-vars */\ndeclare global {\n interface FormData {}\n interface Blob {}\n interface File {}\n interface ReadableStream {}\n interface TransformStream {}\n}\n\n/* eslint-enable @typescript-eslint/no-unused-vars */\nexport type { HttpMethods } from \"@azure/core-util\";\nexport type {\n Agent,\n BodyPart,\n FormDataMap,\n FormDataValue,\n HttpClient,\n HttpHeaders,\n KeyObject,\n MultipartRequestBody,\n PipelineRequest,\n PipelineResponse,\n PipelineRetryOptions,\n ProxySettings,\n PxfObject,\n RawHttpHeaders,\n RawHttpHeadersInput,\n RequestBodyType,\n SendRequest,\n TlsSettings,\n TransferProgressEvent,\n} from \"./interfaces.js\";\nexport {\n type AddPolicyOptions as AddPipelineOptions,\n type PipelinePhase,\n type PipelinePolicy,\n type Pipeline,\n createEmptyPipeline,\n} from \"./pipeline.js\";\nexport {\n createPipelineFromOptions,\n type TelemetryOptions,\n type InternalPipelineOptions,\n type PipelineOptions,\n} from \"./createPipelineFromOptions.js\";\nexport { createDefaultHttpClient } from \"./defaultHttpClient.js\";\nexport { createHttpHeaders } from \"./httpHeaders.js\";\nexport { createPipelineRequest, type PipelineRequestOptions } from \"./pipelineRequest.js\";\nexport { RestError, type RestErrorOptions, isRestError } from \"./restError.js\";\nexport {\n decompressResponsePolicy,\n decompressResponsePolicyName,\n} from \"./policies/decompressResponsePolicy.js\";\nexport {\n exponentialRetryPolicy,\n type ExponentialRetryPolicyOptions,\n exponentialRetryPolicyName,\n} from \"./policies/exponentialRetryPolicy.js\";\nexport {\n setClientRequestIdPolicy,\n setClientRequestIdPolicyName,\n} from \"./policies/setClientRequestIdPolicy.js\";\nexport { logPolicy, logPolicyName, type LogPolicyOptions } from \"./policies/logPolicy.js\";\nexport { multipartPolicy, multipartPolicyName } from \"./policies/multipartPolicy.js\";\nexport { proxyPolicy, proxyPolicyName, getDefaultProxySettings } from \"./policies/proxyPolicy.js\";\nexport {\n redirectPolicy,\n redirectPolicyName,\n type RedirectPolicyOptions,\n} from \"./policies/redirectPolicy.js\";\nexport {\n systemErrorRetryPolicy,\n type SystemErrorRetryPolicyOptions,\n systemErrorRetryPolicyName,\n} from \"./policies/systemErrorRetryPolicy.js\";\nexport {\n throttlingRetryPolicy,\n throttlingRetryPolicyName,\n type ThrottlingRetryPolicyOptions,\n} from \"./policies/throttlingRetryPolicy.js\";\nexport { retryPolicy, type RetryPolicyOptions } from \"./policies/retryPolicy.js\";\nexport type {\n RetryStrategy,\n RetryInformation,\n RetryModifiers,\n} from \"./retryStrategies/retryStrategy.js\";\nexport {\n tracingPolicy,\n tracingPolicyName,\n type TracingPolicyOptions,\n} from \"./policies/tracingPolicy.js\";\nexport {\n defaultRetryPolicy,\n type DefaultRetryPolicyOptions,\n} from \"./policies/defaultRetryPolicy.js\";\nexport {\n userAgentPolicy,\n userAgentPolicyName,\n type UserAgentPolicyOptions,\n} from \"./policies/userAgentPolicy.js\";\nexport { tlsPolicy, tlsPolicyName } from \"./policies/tlsPolicy.js\";\nexport { formDataPolicy, formDataPolicyName } from \"./policies/formDataPolicy.js\";\nexport {\n bearerTokenAuthenticationPolicy,\n type BearerTokenAuthenticationPolicyOptions,\n bearerTokenAuthenticationPolicyName,\n type ChallengeCallbacks,\n type AuthorizeRequestOptions,\n type AuthorizeRequestOnChallengeOptions,\n} from \"./policies/bearerTokenAuthenticationPolicy.js\";\nexport { ndJsonPolicy, ndJsonPolicyName } from \"./policies/ndJsonPolicy.js\";\nexport {\n auxiliaryAuthenticationHeaderPolicy,\n type AuxiliaryAuthenticationHeaderPolicyOptions,\n auxiliaryAuthenticationHeaderPolicyName,\n} from \"./policies/auxiliaryAuthenticationHeaderPolicy.js\";\nexport {\n createFile,\n createFileFromStream,\n type CreateFileOptions,\n type CreateFileFromStreamOptions,\n} from \"./util/file.js\";\n"]} \ No newline at end of file +{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";AAAA,uCAAuC;AACvC,kCAAkC;;;AAgClC,6CAMuB;AADrB,kHAAA,mBAAmB,OAAA;AAErB,+EAKwC;AAJtC,yIAAA,yBAAyB,OAAA;AAK3B,+DAAiE;AAAxD,+HAAA,uBAAuB,OAAA;AAChC,mDAAqD;AAA5C,mHAAA,iBAAiB,OAAA;AAC1B,2DAA0F;AAAjF,2HAAA,qBAAqB,OAAA;AAC9B,+CAA+E;AAAtE,yGAAA,SAAS,OAAA;AAAyB,2GAAA,WAAW,OAAA;AACtD,sFAGgD;AAF9C,uIAAA,wBAAwB,OAAA;AACxB,2IAAA,4BAA4B,OAAA;AAE9B,kFAI8C;AAH5C,mIAAA,sBAAsB,OAAA;AAEtB,uIAAA,0BAA0B,OAAA;AAE5B,sFAGgD;AAF9C,uIAAA,wBAAwB,OAAA;AACxB,2IAAA,4BAA4B,OAAA;AAE9B,wDAA0F;AAAjF,yGAAA,SAAS,OAAA;AAAE,6GAAA,aAAa,OAAA;AACjC,oEAAqF;AAA5E,qHAAA,eAAe,OAAA;AAAE,yHAAA,mBAAmB,OAAA;AAC7C,4DAAkG;AAAzF,6GAAA,WAAW,OAAA;AAAE,iHAAA,eAAe,OAAA;AAAE,yHAAA,uBAAuB,OAAA;AAC9D,kEAIsC;AAHpC,mHAAA,cAAc,OAAA;AACd,uHAAA,kBAAkB,OAAA;AAGpB,kFAI8C;AAH5C,mIAAA,sBAAsB,OAAA;AAEtB,uIAAA,0BAA0B,OAAA;AAE5B,gFAI6C;AAH3C,iIAAA,qBAAqB,OAAA;AACrB,qIAAA,yBAAyB,OAAA;AAG3B,4DAAiF;AAAxE,6GAAA,WAAW,OAAA;AAMpB,gEAIqC;AAHnC,iHAAA,aAAa,OAAA;AACb,qHAAA,iBAAiB,OAAA;AAGnB,0EAG0C;AAFxC,2HAAA,kBAAkB,OAAA;AAGpB,oEAIuC;AAHrC,qHAAA,eAAe,OAAA;AACf,yHAAA,mBAAmB,OAAA;AAGrB,wDAAmE;AAA1D,yGAAA,SAAS,OAAA;AAAE,6GAAA,aAAa,OAAA;AACjC,kEAAkF;AAAzE,mHAAA,cAAc,OAAA;AAAE,uHAAA,kBAAkB,OAAA;AAC3C,oGAOuD;AANrD,qJAAA,+BAA+B,OAAA;AAE/B,yJAAA,mCAAmC,OAAA;AAKrC,8DAA4E;AAAnE,+GAAA,YAAY,OAAA;AAAE,mHAAA,gBAAgB,OAAA;AACvC,4GAI2D;AAHzD,6JAAA,mCAAmC,OAAA;AAEnC,iKAAA,uCAAuC,OAAA;AAEzC,0CAKwB;AAJtB,qGAAA,UAAU,OAAA;AACV,+GAAA,oBAAoB,OAAA","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\ndeclare global {\n interface FormData {}\n interface Blob {}\n interface File {}\n interface ReadableStream {}\n interface TransformStream {}\n}\n\nexport type { HttpMethods } from \"@azure/core-util\";\nexport type {\n Agent,\n BodyPart,\n FormDataMap,\n FormDataValue,\n HttpClient,\n HttpHeaders,\n KeyObject,\n MultipartRequestBody,\n PipelineRequest,\n PipelineResponse,\n PipelineRetryOptions,\n ProxySettings,\n PxfObject,\n RawHttpHeaders,\n RawHttpHeadersInput,\n RequestBodyType,\n SendRequest,\n TlsSettings,\n TransferProgressEvent,\n} from \"./interfaces.js\";\nexport {\n type AddPolicyOptions as AddPipelineOptions,\n type PipelinePhase,\n type PipelinePolicy,\n type Pipeline,\n createEmptyPipeline,\n} from \"./pipeline.js\";\nexport {\n createPipelineFromOptions,\n type TelemetryOptions,\n type InternalPipelineOptions,\n type PipelineOptions,\n} from \"./createPipelineFromOptions.js\";\nexport { createDefaultHttpClient } from \"./defaultHttpClient.js\";\nexport { createHttpHeaders } from \"./httpHeaders.js\";\nexport { createPipelineRequest, type PipelineRequestOptions } from \"./pipelineRequest.js\";\nexport { RestError, type RestErrorOptions, isRestError } from \"./restError.js\";\nexport {\n decompressResponsePolicy,\n decompressResponsePolicyName,\n} from \"./policies/decompressResponsePolicy.js\";\nexport {\n exponentialRetryPolicy,\n type ExponentialRetryPolicyOptions,\n exponentialRetryPolicyName,\n} from \"./policies/exponentialRetryPolicy.js\";\nexport {\n setClientRequestIdPolicy,\n setClientRequestIdPolicyName,\n} from \"./policies/setClientRequestIdPolicy.js\";\nexport { logPolicy, logPolicyName, type LogPolicyOptions } from \"./policies/logPolicy.js\";\nexport { multipartPolicy, multipartPolicyName } from \"./policies/multipartPolicy.js\";\nexport { proxyPolicy, proxyPolicyName, getDefaultProxySettings } from \"./policies/proxyPolicy.js\";\nexport {\n redirectPolicy,\n redirectPolicyName,\n type RedirectPolicyOptions,\n} from \"./policies/redirectPolicy.js\";\nexport {\n systemErrorRetryPolicy,\n type SystemErrorRetryPolicyOptions,\n systemErrorRetryPolicyName,\n} from \"./policies/systemErrorRetryPolicy.js\";\nexport {\n throttlingRetryPolicy,\n throttlingRetryPolicyName,\n type ThrottlingRetryPolicyOptions,\n} from \"./policies/throttlingRetryPolicy.js\";\nexport { retryPolicy, type RetryPolicyOptions } from \"./policies/retryPolicy.js\";\nexport type {\n RetryStrategy,\n RetryInformation,\n RetryModifiers,\n} from \"./retryStrategies/retryStrategy.js\";\nexport {\n tracingPolicy,\n tracingPolicyName,\n type TracingPolicyOptions,\n} from \"./policies/tracingPolicy.js\";\nexport {\n defaultRetryPolicy,\n type DefaultRetryPolicyOptions,\n} from \"./policies/defaultRetryPolicy.js\";\nexport {\n userAgentPolicy,\n userAgentPolicyName,\n type UserAgentPolicyOptions,\n} from \"./policies/userAgentPolicy.js\";\nexport { tlsPolicy, tlsPolicyName } from \"./policies/tlsPolicy.js\";\nexport { formDataPolicy, formDataPolicyName } from \"./policies/formDataPolicy.js\";\nexport {\n bearerTokenAuthenticationPolicy,\n type BearerTokenAuthenticationPolicyOptions,\n bearerTokenAuthenticationPolicyName,\n type ChallengeCallbacks,\n type AuthorizeRequestOptions,\n type AuthorizeRequestOnChallengeOptions,\n} from \"./policies/bearerTokenAuthenticationPolicy.js\";\nexport { ndJsonPolicy, ndJsonPolicyName } from \"./policies/ndJsonPolicy.js\";\nexport {\n auxiliaryAuthenticationHeaderPolicy,\n type AuxiliaryAuthenticationHeaderPolicyOptions,\n auxiliaryAuthenticationHeaderPolicyName,\n} from \"./policies/auxiliaryAuthenticationHeaderPolicy.js\";\nexport {\n createFile,\n createFileFromStream,\n type CreateFileOptions,\n type CreateFileFromStreamOptions,\n} from \"./util/file.js\";\n"]} \ No newline at end of file diff --git a/node_modules/@azure/core-rest-pipeline/dist/commonjs/policies/retryPolicy.d.ts.map b/node_modules/@azure/core-rest-pipeline/dist/commonjs/policies/retryPolicy.d.ts.map index d4afad3b..a94ed48e 100644 --- a/node_modules/@azure/core-rest-pipeline/dist/commonjs/policies/retryPolicy.d.ts.map +++ b/node_modules/@azure/core-rest-pipeline/dist/commonjs/policies/retryPolicy.d.ts.map @@ -1 +1 @@ -{"version":3,"file":"retryPolicy.d.ts","sourceRoot":"","sources":["../../../src/policies/retryPolicy.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAErD,OAAO,EAAE,KAAK,WAAW,EAAsB,MAAM,eAAe,CAAC;AACrE,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,qCAAqC,CAAC;AAYzE;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,MAAM,CAAC,EAAE,WAAW,CAAC;CACtB;AAED;;GAEG;AACH,wBAAgB,WAAW,CACzB,UAAU,EAAE,aAAa,EAAE,EAC3B,OAAO,GAAE,kBAA+D,GACvE,cAAc,CAmHhB"} \ No newline at end of file +{"version":3,"file":"retryPolicy.d.ts","sourceRoot":"","sources":["../../../src/policies/retryPolicy.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAErD,OAAO,EAAE,KAAK,WAAW,EAAsB,MAAM,eAAe,CAAC;AACrE,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,qCAAqC,CAAC;AAYzE;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,MAAM,CAAC,EAAE,WAAW,CAAC;CACtB;AAED;;GAEG;AACH,wBAAgB,WAAW,CACzB,UAAU,EAAE,aAAa,EAAE,EAC3B,OAAO,GAAE,kBAA+D,GACvE,cAAc,CAkHhB"} \ No newline at end of file diff --git a/node_modules/@azure/core-rest-pipeline/dist/commonjs/policies/retryPolicy.js b/node_modules/@azure/core-rest-pipeline/dist/commonjs/policies/retryPolicy.js index 52e63f3f..e1fccdb9 100644 --- a/node_modules/@azure/core-rest-pipeline/dist/commonjs/policies/retryPolicy.js +++ b/node_modules/@azure/core-rest-pipeline/dist/commonjs/policies/retryPolicy.js @@ -24,7 +24,6 @@ function retryPolicy(strategies, options = { maxRetries: constants_js_1.DEFAULT_ let response; let responseError; let retryCount = -1; - // eslint-disable-next-line no-constant-condition retryRequest: while (true) { retryCount += 1; response = undefined; diff --git a/node_modules/@azure/core-rest-pipeline/dist/commonjs/policies/retryPolicy.js.map b/node_modules/@azure/core-rest-pipeline/dist/commonjs/policies/retryPolicy.js.map index 49ced185..bcc6172f 100644 --- a/node_modules/@azure/core-rest-pipeline/dist/commonjs/policies/retryPolicy.js.map +++ b/node_modules/@azure/core-rest-pipeline/dist/commonjs/policies/retryPolicy.js.map @@ -1 +1 @@ -{"version":3,"file":"retryPolicy.js","sourceRoot":"","sources":["../../../src/policies/retryPolicy.ts"],"names":[],"mappings":";AAAA,uCAAuC;AACvC,kCAAkC;;AAmClC,kCAsHC;AArJD,mDAA2C;AAC3C,0CAAqE;AAGrE,8DAAqD;AACrD,kDAA6D;AAE7D,MAAM,iBAAiB,GAAG,IAAA,2BAAkB,EAAC,gCAAgC,CAAC,CAAC;AAE/E;;GAEG;AACH,MAAM,eAAe,GAAG,aAAa,CAAC;AAgBtC;;GAEG;AACH,SAAgB,WAAW,CACzB,UAA2B,EAC3B,UAA8B,EAAE,UAAU,EAAE,yCAA0B,EAAE;IAExE,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,IAAI,iBAAiB,CAAC;IACnD,OAAO;QACL,IAAI,EAAE,eAAe;QACrB,KAAK,CAAC,WAAW,CAAC,OAAwB,EAAE,IAAiB;;YAC3D,IAAI,QAAsC,CAAC;YAC3C,IAAI,aAAoC,CAAC;YACzC,IAAI,UAAU,GAAG,CAAC,CAAC,CAAC;YAEpB,iDAAiD;YACjD,YAAY,EAAE,OAAO,IAAI,EAAE,CAAC;gBAC1B,UAAU,IAAI,CAAC,CAAC;gBAChB,QAAQ,GAAG,SAAS,CAAC;gBACrB,aAAa,GAAG,SAAS,CAAC;gBAE1B,IAAI,CAAC;oBACH,MAAM,CAAC,IAAI,CAAC,SAAS,UAAU,8BAA8B,EAAE,OAAO,CAAC,SAAS,CAAC,CAAC;oBAClF,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,CAAC;oBAC/B,MAAM,CAAC,IAAI,CAAC,SAAS,UAAU,oCAAoC,EAAE,OAAO,CAAC,SAAS,CAAC,CAAC;gBAC1F,CAAC;gBAAC,OAAO,CAAM,EAAE,CAAC;oBAChB,MAAM,CAAC,KAAK,CAAC,SAAS,UAAU,kCAAkC,EAAE,OAAO,CAAC,SAAS,CAAC,CAAC;oBAEvF,yDAAyD;oBACzD,gGAAgG;oBAChG,sEAAsE;oBACtE,aAAa,GAAG,CAAc,CAAC;oBAC/B,IAAI,CAAC,CAAC,IAAI,aAAa,CAAC,IAAI,KAAK,WAAW,EAAE,CAAC;wBAC7C,MAAM,CAAC,CAAC;oBACV,CAAC;oBAED,QAAQ,GAAG,aAAa,CAAC,QAAQ,CAAC;gBACpC,CAAC;gBAED,IAAI,MAAA,OAAO,CAAC,WAAW,0CAAE,OAAO,EAAE,CAAC;oBACjC,MAAM,CAAC,KAAK,CAAC,SAAS,UAAU,oBAAoB,CAAC,CAAC;oBACtD,MAAM,UAAU,GAAG,IAAI,6BAAU,EAAE,CAAC;oBACpC,MAAM,UAAU,CAAC;gBACnB,CAAC;gBAED,IAAI,UAAU,IAAI,CAAC,MAAA,OAAO,CAAC,UAAU,mCAAI,yCAA0B,CAAC,EAAE,CAAC;oBACrE,MAAM,CAAC,IAAI,CACT,SAAS,UAAU,uGAAuG,CAC3H,CAAC;oBACF,IAAI,aAAa,EAAE,CAAC;wBAClB,MAAM,aAAa,CAAC;oBACtB,CAAC;yBAAM,IAAI,QAAQ,EAAE,CAAC;wBACpB,OAAO,QAAQ,CAAC;oBAClB,CAAC;yBAAM,CAAC;wBACN,MAAM,IAAI,KAAK,CAAC,4DAA4D,CAAC,CAAC;oBAChF,CAAC;gBACH,CAAC;gBAED,MAAM,CAAC,IAAI,CAAC,SAAS,UAAU,gBAAgB,UAAU,CAAC,MAAM,oBAAoB,CAAC,CAAC;gBAEtF,cAAc,EAAE,KAAK,MAAM,QAAQ,IAAI,UAAU,EAAE,CAAC;oBAClD,MAAM,cAAc,GAAG,QAAQ,CAAC,MAAM,IAAI,iBAAiB,CAAC;oBAC5D,cAAc,CAAC,IAAI,CAAC,SAAS,UAAU,+BAA+B,QAAQ,CAAC,IAAI,GAAG,CAAC,CAAC;oBAExF,MAAM,SAAS,GAAG,QAAQ,CAAC,KAAK,CAAC;wBAC/B,UAAU;wBACV,QAAQ;wBACR,aAAa;qBACd,CAAC,CAAC;oBAEH,IAAI,SAAS,CAAC,YAAY,EAAE,CAAC;wBAC3B,cAAc,CAAC,IAAI,CAAC,SAAS,UAAU,YAAY,CAAC,CAAC;wBACrD,SAAS,cAAc,CAAC;oBAC1B,CAAC;oBAED,MAAM,EAAE,YAAY,EAAE,cAAc,EAAE,UAAU,EAAE,GAAG,SAAS,CAAC;oBAE/D,IAAI,YAAY,EAAE,CAAC;wBACjB,cAAc,CAAC,KAAK,CAClB,SAAS,UAAU,oBAAoB,QAAQ,CAAC,IAAI,gBAAgB,EACpE,YAAY,CACb,CAAC;wBACF,MAAM,YAAY,CAAC;oBACrB,CAAC;oBAED,IAAI,cAAc,IAAI,cAAc,KAAK,CAAC,EAAE,CAAC;wBAC3C,cAAc,CAAC,IAAI,CACjB,SAAS,UAAU,oBAAoB,QAAQ,CAAC,IAAI,kBAAkB,cAAc,EAAE,CACvF,CAAC;wBACF,MAAM,IAAA,kBAAK,EAAC,cAAc,EAAE,SAAS,EAAE,EAAE,WAAW,EAAE,OAAO,CAAC,WAAW,EAAE,CAAC,CAAC;wBAC7E,SAAS,YAAY,CAAC;oBACxB,CAAC;oBAED,IAAI,UAAU,EAAE,CAAC;wBACf,cAAc,CAAC,IAAI,CACjB,SAAS,UAAU,oBAAoB,QAAQ,CAAC,IAAI,iBAAiB,UAAU,EAAE,CAClF,CAAC;wBACF,OAAO,CAAC,GAAG,GAAG,UAAU,CAAC;wBACzB,SAAS,YAAY,CAAC;oBACxB,CAAC;gBACH,CAAC;gBAED,IAAI,aAAa,EAAE,CAAC;oBAClB,MAAM,CAAC,IAAI,CACT,+EAA+E,CAChF,CAAC;oBACF,MAAM,aAAa,CAAC;gBACtB,CAAC;gBACD,IAAI,QAAQ,EAAE,CAAC;oBACb,MAAM,CAAC,IAAI,CACT,mFAAmF,CACpF,CAAC;oBACF,OAAO,QAAQ,CAAC;gBAClB,CAAC;gBAED,mDAAmD;gBACnD,+DAA+D;gBAC/D,iCAAiC;YACnC,CAAC;QACH,CAAC;KACF,CAAC;AACJ,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport type { PipelineRequest, PipelineResponse, SendRequest } from \"../interfaces.js\";\nimport type { PipelinePolicy } from \"../pipeline.js\";\nimport { delay } from \"../util/helpers.js\";\nimport { type AzureLogger, createClientLogger } from \"@azure/logger\";\nimport type { RetryStrategy } from \"../retryStrategies/retryStrategy.js\";\nimport type { RestError } from \"../restError.js\";\nimport { AbortError } from \"@azure/abort-controller\";\nimport { DEFAULT_RETRY_POLICY_COUNT } from \"../constants.js\";\n\nconst retryPolicyLogger = createClientLogger(\"core-rest-pipeline retryPolicy\");\n\n/**\n * The programmatic identifier of the retryPolicy.\n */\nconst retryPolicyName = \"retryPolicy\";\n\n/**\n * Options to the {@link retryPolicy}\n */\nexport interface RetryPolicyOptions {\n /**\n * Maximum number of retries. If not specified, it will limit to 3 retries.\n */\n maxRetries?: number;\n /**\n * Logger. If it's not provided, a default logger is used.\n */\n logger?: AzureLogger;\n}\n\n/**\n * retryPolicy is a generic policy to enable retrying requests when certain conditions are met\n */\nexport function retryPolicy(\n strategies: RetryStrategy[],\n options: RetryPolicyOptions = { maxRetries: DEFAULT_RETRY_POLICY_COUNT },\n): PipelinePolicy {\n const logger = options.logger || retryPolicyLogger;\n return {\n name: retryPolicyName,\n async sendRequest(request: PipelineRequest, next: SendRequest): Promise {\n let response: PipelineResponse | undefined;\n let responseError: RestError | undefined;\n let retryCount = -1;\n\n // eslint-disable-next-line no-constant-condition\n retryRequest: while (true) {\n retryCount += 1;\n response = undefined;\n responseError = undefined;\n\n try {\n logger.info(`Retry ${retryCount}: Attempting to send request`, request.requestId);\n response = await next(request);\n logger.info(`Retry ${retryCount}: Received a response from request`, request.requestId);\n } catch (e: any) {\n logger.error(`Retry ${retryCount}: Received an error from request`, request.requestId);\n\n // RestErrors are valid targets for the retry strategies.\n // If none of the retry strategies can work with them, they will be thrown later in this policy.\n // If the received error is not a RestError, it is immediately thrown.\n responseError = e as RestError;\n if (!e || responseError.name !== \"RestError\") {\n throw e;\n }\n\n response = responseError.response;\n }\n\n if (request.abortSignal?.aborted) {\n logger.error(`Retry ${retryCount}: Request aborted.`);\n const abortError = new AbortError();\n throw abortError;\n }\n\n if (retryCount >= (options.maxRetries ?? DEFAULT_RETRY_POLICY_COUNT)) {\n logger.info(\n `Retry ${retryCount}: Maximum retries reached. Returning the last received response, or throwing the last received error.`,\n );\n if (responseError) {\n throw responseError;\n } else if (response) {\n return response;\n } else {\n throw new Error(\"Maximum retries reached with no response or error to throw\");\n }\n }\n\n logger.info(`Retry ${retryCount}: Processing ${strategies.length} retry strategies.`);\n\n strategiesLoop: for (const strategy of strategies) {\n const strategyLogger = strategy.logger || retryPolicyLogger;\n strategyLogger.info(`Retry ${retryCount}: Processing retry strategy ${strategy.name}.`);\n\n const modifiers = strategy.retry({\n retryCount,\n response,\n responseError,\n });\n\n if (modifiers.skipStrategy) {\n strategyLogger.info(`Retry ${retryCount}: Skipped.`);\n continue strategiesLoop;\n }\n\n const { errorToThrow, retryAfterInMs, redirectTo } = modifiers;\n\n if (errorToThrow) {\n strategyLogger.error(\n `Retry ${retryCount}: Retry strategy ${strategy.name} throws error:`,\n errorToThrow,\n );\n throw errorToThrow;\n }\n\n if (retryAfterInMs || retryAfterInMs === 0) {\n strategyLogger.info(\n `Retry ${retryCount}: Retry strategy ${strategy.name} retries after ${retryAfterInMs}`,\n );\n await delay(retryAfterInMs, undefined, { abortSignal: request.abortSignal });\n continue retryRequest;\n }\n\n if (redirectTo) {\n strategyLogger.info(\n `Retry ${retryCount}: Retry strategy ${strategy.name} redirects to ${redirectTo}`,\n );\n request.url = redirectTo;\n continue retryRequest;\n }\n }\n\n if (responseError) {\n logger.info(\n `None of the retry strategies could work with the received error. Throwing it.`,\n );\n throw responseError;\n }\n if (response) {\n logger.info(\n `None of the retry strategies could work with the received response. Returning it.`,\n );\n return response;\n }\n\n // If all the retries skip and there's no response,\n // we're still in the retry loop, so a new request will be sent\n // until `maxRetries` is reached.\n }\n },\n };\n}\n"]} \ No newline at end of file +{"version":3,"file":"retryPolicy.js","sourceRoot":"","sources":["../../../src/policies/retryPolicy.ts"],"names":[],"mappings":";AAAA,uCAAuC;AACvC,kCAAkC;;AAmClC,kCAqHC;AApJD,mDAA2C;AAC3C,0CAAqE;AAGrE,8DAAqD;AACrD,kDAA6D;AAE7D,MAAM,iBAAiB,GAAG,IAAA,2BAAkB,EAAC,gCAAgC,CAAC,CAAC;AAE/E;;GAEG;AACH,MAAM,eAAe,GAAG,aAAa,CAAC;AAgBtC;;GAEG;AACH,SAAgB,WAAW,CACzB,UAA2B,EAC3B,UAA8B,EAAE,UAAU,EAAE,yCAA0B,EAAE;IAExE,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,IAAI,iBAAiB,CAAC;IACnD,OAAO;QACL,IAAI,EAAE,eAAe;QACrB,KAAK,CAAC,WAAW,CAAC,OAAwB,EAAE,IAAiB;;YAC3D,IAAI,QAAsC,CAAC;YAC3C,IAAI,aAAoC,CAAC;YACzC,IAAI,UAAU,GAAG,CAAC,CAAC,CAAC;YAEpB,YAAY,EAAE,OAAO,IAAI,EAAE,CAAC;gBAC1B,UAAU,IAAI,CAAC,CAAC;gBAChB,QAAQ,GAAG,SAAS,CAAC;gBACrB,aAAa,GAAG,SAAS,CAAC;gBAE1B,IAAI,CAAC;oBACH,MAAM,CAAC,IAAI,CAAC,SAAS,UAAU,8BAA8B,EAAE,OAAO,CAAC,SAAS,CAAC,CAAC;oBAClF,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,CAAC;oBAC/B,MAAM,CAAC,IAAI,CAAC,SAAS,UAAU,oCAAoC,EAAE,OAAO,CAAC,SAAS,CAAC,CAAC;gBAC1F,CAAC;gBAAC,OAAO,CAAM,EAAE,CAAC;oBAChB,MAAM,CAAC,KAAK,CAAC,SAAS,UAAU,kCAAkC,EAAE,OAAO,CAAC,SAAS,CAAC,CAAC;oBAEvF,yDAAyD;oBACzD,gGAAgG;oBAChG,sEAAsE;oBACtE,aAAa,GAAG,CAAc,CAAC;oBAC/B,IAAI,CAAC,CAAC,IAAI,aAAa,CAAC,IAAI,KAAK,WAAW,EAAE,CAAC;wBAC7C,MAAM,CAAC,CAAC;oBACV,CAAC;oBAED,QAAQ,GAAG,aAAa,CAAC,QAAQ,CAAC;gBACpC,CAAC;gBAED,IAAI,MAAA,OAAO,CAAC,WAAW,0CAAE,OAAO,EAAE,CAAC;oBACjC,MAAM,CAAC,KAAK,CAAC,SAAS,UAAU,oBAAoB,CAAC,CAAC;oBACtD,MAAM,UAAU,GAAG,IAAI,6BAAU,EAAE,CAAC;oBACpC,MAAM,UAAU,CAAC;gBACnB,CAAC;gBAED,IAAI,UAAU,IAAI,CAAC,MAAA,OAAO,CAAC,UAAU,mCAAI,yCAA0B,CAAC,EAAE,CAAC;oBACrE,MAAM,CAAC,IAAI,CACT,SAAS,UAAU,uGAAuG,CAC3H,CAAC;oBACF,IAAI,aAAa,EAAE,CAAC;wBAClB,MAAM,aAAa,CAAC;oBACtB,CAAC;yBAAM,IAAI,QAAQ,EAAE,CAAC;wBACpB,OAAO,QAAQ,CAAC;oBAClB,CAAC;yBAAM,CAAC;wBACN,MAAM,IAAI,KAAK,CAAC,4DAA4D,CAAC,CAAC;oBAChF,CAAC;gBACH,CAAC;gBAED,MAAM,CAAC,IAAI,CAAC,SAAS,UAAU,gBAAgB,UAAU,CAAC,MAAM,oBAAoB,CAAC,CAAC;gBAEtF,cAAc,EAAE,KAAK,MAAM,QAAQ,IAAI,UAAU,EAAE,CAAC;oBAClD,MAAM,cAAc,GAAG,QAAQ,CAAC,MAAM,IAAI,iBAAiB,CAAC;oBAC5D,cAAc,CAAC,IAAI,CAAC,SAAS,UAAU,+BAA+B,QAAQ,CAAC,IAAI,GAAG,CAAC,CAAC;oBAExF,MAAM,SAAS,GAAG,QAAQ,CAAC,KAAK,CAAC;wBAC/B,UAAU;wBACV,QAAQ;wBACR,aAAa;qBACd,CAAC,CAAC;oBAEH,IAAI,SAAS,CAAC,YAAY,EAAE,CAAC;wBAC3B,cAAc,CAAC,IAAI,CAAC,SAAS,UAAU,YAAY,CAAC,CAAC;wBACrD,SAAS,cAAc,CAAC;oBAC1B,CAAC;oBAED,MAAM,EAAE,YAAY,EAAE,cAAc,EAAE,UAAU,EAAE,GAAG,SAAS,CAAC;oBAE/D,IAAI,YAAY,EAAE,CAAC;wBACjB,cAAc,CAAC,KAAK,CAClB,SAAS,UAAU,oBAAoB,QAAQ,CAAC,IAAI,gBAAgB,EACpE,YAAY,CACb,CAAC;wBACF,MAAM,YAAY,CAAC;oBACrB,CAAC;oBAED,IAAI,cAAc,IAAI,cAAc,KAAK,CAAC,EAAE,CAAC;wBAC3C,cAAc,CAAC,IAAI,CACjB,SAAS,UAAU,oBAAoB,QAAQ,CAAC,IAAI,kBAAkB,cAAc,EAAE,CACvF,CAAC;wBACF,MAAM,IAAA,kBAAK,EAAC,cAAc,EAAE,SAAS,EAAE,EAAE,WAAW,EAAE,OAAO,CAAC,WAAW,EAAE,CAAC,CAAC;wBAC7E,SAAS,YAAY,CAAC;oBACxB,CAAC;oBAED,IAAI,UAAU,EAAE,CAAC;wBACf,cAAc,CAAC,IAAI,CACjB,SAAS,UAAU,oBAAoB,QAAQ,CAAC,IAAI,iBAAiB,UAAU,EAAE,CAClF,CAAC;wBACF,OAAO,CAAC,GAAG,GAAG,UAAU,CAAC;wBACzB,SAAS,YAAY,CAAC;oBACxB,CAAC;gBACH,CAAC;gBAED,IAAI,aAAa,EAAE,CAAC;oBAClB,MAAM,CAAC,IAAI,CACT,+EAA+E,CAChF,CAAC;oBACF,MAAM,aAAa,CAAC;gBACtB,CAAC;gBACD,IAAI,QAAQ,EAAE,CAAC;oBACb,MAAM,CAAC,IAAI,CACT,mFAAmF,CACpF,CAAC;oBACF,OAAO,QAAQ,CAAC;gBAClB,CAAC;gBAED,mDAAmD;gBACnD,+DAA+D;gBAC/D,iCAAiC;YACnC,CAAC;QACH,CAAC;KACF,CAAC;AACJ,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport type { PipelineRequest, PipelineResponse, SendRequest } from \"../interfaces.js\";\nimport type { PipelinePolicy } from \"../pipeline.js\";\nimport { delay } from \"../util/helpers.js\";\nimport { type AzureLogger, createClientLogger } from \"@azure/logger\";\nimport type { RetryStrategy } from \"../retryStrategies/retryStrategy.js\";\nimport type { RestError } from \"../restError.js\";\nimport { AbortError } from \"@azure/abort-controller\";\nimport { DEFAULT_RETRY_POLICY_COUNT } from \"../constants.js\";\n\nconst retryPolicyLogger = createClientLogger(\"core-rest-pipeline retryPolicy\");\n\n/**\n * The programmatic identifier of the retryPolicy.\n */\nconst retryPolicyName = \"retryPolicy\";\n\n/**\n * Options to the {@link retryPolicy}\n */\nexport interface RetryPolicyOptions {\n /**\n * Maximum number of retries. If not specified, it will limit to 3 retries.\n */\n maxRetries?: number;\n /**\n * Logger. If it's not provided, a default logger is used.\n */\n logger?: AzureLogger;\n}\n\n/**\n * retryPolicy is a generic policy to enable retrying requests when certain conditions are met\n */\nexport function retryPolicy(\n strategies: RetryStrategy[],\n options: RetryPolicyOptions = { maxRetries: DEFAULT_RETRY_POLICY_COUNT },\n): PipelinePolicy {\n const logger = options.logger || retryPolicyLogger;\n return {\n name: retryPolicyName,\n async sendRequest(request: PipelineRequest, next: SendRequest): Promise {\n let response: PipelineResponse | undefined;\n let responseError: RestError | undefined;\n let retryCount = -1;\n\n retryRequest: while (true) {\n retryCount += 1;\n response = undefined;\n responseError = undefined;\n\n try {\n logger.info(`Retry ${retryCount}: Attempting to send request`, request.requestId);\n response = await next(request);\n logger.info(`Retry ${retryCount}: Received a response from request`, request.requestId);\n } catch (e: any) {\n logger.error(`Retry ${retryCount}: Received an error from request`, request.requestId);\n\n // RestErrors are valid targets for the retry strategies.\n // If none of the retry strategies can work with them, they will be thrown later in this policy.\n // If the received error is not a RestError, it is immediately thrown.\n responseError = e as RestError;\n if (!e || responseError.name !== \"RestError\") {\n throw e;\n }\n\n response = responseError.response;\n }\n\n if (request.abortSignal?.aborted) {\n logger.error(`Retry ${retryCount}: Request aborted.`);\n const abortError = new AbortError();\n throw abortError;\n }\n\n if (retryCount >= (options.maxRetries ?? DEFAULT_RETRY_POLICY_COUNT)) {\n logger.info(\n `Retry ${retryCount}: Maximum retries reached. Returning the last received response, or throwing the last received error.`,\n );\n if (responseError) {\n throw responseError;\n } else if (response) {\n return response;\n } else {\n throw new Error(\"Maximum retries reached with no response or error to throw\");\n }\n }\n\n logger.info(`Retry ${retryCount}: Processing ${strategies.length} retry strategies.`);\n\n strategiesLoop: for (const strategy of strategies) {\n const strategyLogger = strategy.logger || retryPolicyLogger;\n strategyLogger.info(`Retry ${retryCount}: Processing retry strategy ${strategy.name}.`);\n\n const modifiers = strategy.retry({\n retryCount,\n response,\n responseError,\n });\n\n if (modifiers.skipStrategy) {\n strategyLogger.info(`Retry ${retryCount}: Skipped.`);\n continue strategiesLoop;\n }\n\n const { errorToThrow, retryAfterInMs, redirectTo } = modifiers;\n\n if (errorToThrow) {\n strategyLogger.error(\n `Retry ${retryCount}: Retry strategy ${strategy.name} throws error:`,\n errorToThrow,\n );\n throw errorToThrow;\n }\n\n if (retryAfterInMs || retryAfterInMs === 0) {\n strategyLogger.info(\n `Retry ${retryCount}: Retry strategy ${strategy.name} retries after ${retryAfterInMs}`,\n );\n await delay(retryAfterInMs, undefined, { abortSignal: request.abortSignal });\n continue retryRequest;\n }\n\n if (redirectTo) {\n strategyLogger.info(\n `Retry ${retryCount}: Retry strategy ${strategy.name} redirects to ${redirectTo}`,\n );\n request.url = redirectTo;\n continue retryRequest;\n }\n }\n\n if (responseError) {\n logger.info(\n `None of the retry strategies could work with the received error. Throwing it.`,\n );\n throw responseError;\n }\n if (response) {\n logger.info(\n `None of the retry strategies could work with the received response. Returning it.`,\n );\n return response;\n }\n\n // If all the retries skip and there's no response,\n // we're still in the retry loop, so a new request will be sent\n // until `maxRetries` is reached.\n }\n },\n };\n}\n"]} \ No newline at end of file diff --git a/node_modules/@azure/core-rest-pipeline/dist/commonjs/policies/tracingPolicy.js b/node_modules/@azure/core-rest-pipeline/dist/commonjs/policies/tracingPolicy.js index 3daa3abf..9ab08131 100644 --- a/node_modules/@azure/core-rest-pipeline/dist/commonjs/policies/tracingPolicy.js +++ b/node_modules/@azure/core-rest-pipeline/dist/commonjs/policies/tracingPolicy.js @@ -119,9 +119,14 @@ function tryProcessResponse(span, response) { if (serviceRequestId) { span.setAttribute("serviceRequestId", serviceRequestId); } - span.setStatus({ - status: "success", - }); + // Per semantic conventions, only set the status to error if the status code is 4xx or 5xx. + // Otherwise, the status MUST remain unset. + // https://opentelemetry.io/docs/specs/semconv/http/http-spans/#status + if (response.status >= 400) { + span.setStatus({ + status: "error", + }); + } span.end(); } catch (e) { diff --git a/node_modules/@azure/core-rest-pipeline/dist/commonjs/policies/tracingPolicy.js.map b/node_modules/@azure/core-rest-pipeline/dist/commonjs/policies/tracingPolicy.js.map index 5b4c2e7b..d523c69a 100644 --- a/node_modules/@azure/core-rest-pipeline/dist/commonjs/policies/tracingPolicy.js.map +++ b/node_modules/@azure/core-rest-pipeline/dist/commonjs/policies/tracingPolicy.js.map @@ -1 +1 @@ -{"version":3,"file":"tracingPolicy.js","sourceRoot":"","sources":["../../../src/policies/tracingPolicy.ts"],"names":[],"mappings":";AAAA,uCAAuC;AACvC,kCAAkC;;;AA6ClC,sCA0CC;AArFD,sDAK6B;AAC7B,kDAA8C;AAG9C,uDAAyD;AACzD,sCAAmC;AACnC,gDAA4D;AAC5D,kDAA8C;AAC9C,uDAAiD;AAEjD;;GAEG;AACU,QAAA,iBAAiB,GAAG,eAAe,CAAC;AAmBjD;;;;;GAKG;AACH,SAAgB,aAAa,CAAC,UAAgC,EAAE;IAC9D,MAAM,gBAAgB,GAAG,IAAA,gCAAiB,EAAC,OAAO,CAAC,eAAe,CAAC,CAAC;IACpE,MAAM,SAAS,GAAG,IAAI,wBAAS,CAAC;QAC9B,gCAAgC,EAAE,OAAO,CAAC,gCAAgC;KAC3E,CAAC,CAAC;IACH,MAAM,aAAa,GAAG,sBAAsB,EAAE,CAAC;IAE/C,OAAO;QACL,IAAI,EAAE,yBAAiB;QACvB,KAAK,CAAC,WAAW,CAAC,OAAwB,EAAE,IAAiB;;YAC3D,IAAI,CAAC,aAAa,EAAE,CAAC;gBACnB,OAAO,IAAI,CAAC,OAAO,CAAC,CAAC;YACvB,CAAC;YAED,MAAM,SAAS,GAAG,MAAM,gBAAgB,CAAC;YAEzC,MAAM,cAAc,GAAG;gBACrB,UAAU,EAAE,SAAS,CAAC,WAAW,CAAC,OAAO,CAAC,GAAG,CAAC;gBAC9C,aAAa,EAAE,OAAO,CAAC,MAAM;gBAC7B,iBAAiB,EAAE,SAAS;gBAC5B,SAAS,EAAE,OAAO,CAAC,SAAS;aAC7B,CAAC;YACF,IAAI,SAAS,EAAE,CAAC;gBACd,cAAc,CAAC,iBAAiB,CAAC,GAAG,SAAS,CAAC;YAChD,CAAC;YAED,MAAM,EAAE,IAAI,EAAE,cAAc,EAAE,GAAG,MAAA,aAAa,CAAC,aAAa,EAAE,OAAO,EAAE,cAAc,CAAC,mCAAI,EAAE,CAAC;YAE7F,IAAI,CAAC,IAAI,IAAI,CAAC,cAAc,EAAE,CAAC;gBAC7B,OAAO,IAAI,CAAC,OAAO,CAAC,CAAC;YACvB,CAAC;YAED,IAAI,CAAC;gBACH,MAAM,QAAQ,GAAG,MAAM,aAAa,CAAC,WAAW,CAAC,cAAc,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;gBAChF,kBAAkB,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;gBACnC,OAAO,QAAQ,CAAC;YAClB,CAAC;YAAC,OAAO,GAAQ,EAAE,CAAC;gBAClB,eAAe,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;gBAC3B,MAAM,GAAG,CAAC;YACZ,CAAC;QACH,CAAC;KACF,CAAC;AACJ,CAAC;AAED,SAAS,sBAAsB;IAC7B,IAAI,CAAC;QACH,OAAO,IAAA,kCAAmB,EAAC;YACzB,SAAS,EAAE,EAAE;YACb,WAAW,EAAE,2BAA2B;YACxC,cAAc,EAAE,0BAAW;SAC5B,CAAC,CAAC;IACL,CAAC;IAAC,OAAO,CAAU,EAAE,CAAC;QACpB,eAAM,CAAC,OAAO,CAAC,0CAA0C,IAAA,2BAAe,EAAC,CAAC,CAAC,EAAE,CAAC,CAAC;QAC/E,OAAO,SAAS,CAAC;IACnB,CAAC;AACH,CAAC;AAED,SAAS,aAAa,CACpB,aAA4B,EAC5B,OAAwB,EACxB,cAAuC;IAEvC,IAAI,CAAC;QACH,oFAAoF;QACpF,MAAM,EAAE,IAAI,EAAE,cAAc,EAAE,GAAG,aAAa,CAAC,SAAS,CACtD,QAAQ,OAAO,CAAC,MAAM,EAAE,EACxB,EAAE,cAAc,EAAE,OAAO,CAAC,cAAc,EAAE,EAC1C;YACE,QAAQ,EAAE,QAAQ;YAClB,cAAc;SACf,CACF,CAAC;QAEF,wDAAwD;QACxD,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,EAAE,CAAC;YACxB,IAAI,CAAC,GAAG,EAAE,CAAC;YACX,OAAO,SAAS,CAAC;QACnB,CAAC;QAED,cAAc;QACd,MAAM,OAAO,GAAG,aAAa,CAAC,oBAAoB,CAChD,cAAc,CAAC,cAAc,CAAC,cAAc,CAC7C,CAAC;QACF,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC;YACnD,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;QAClC,CAAC;QACD,OAAO,EAAE,IAAI,EAAE,cAAc,EAAE,cAAc,CAAC,cAAc,CAAC,cAAc,EAAE,CAAC;IAChF,CAAC;IAAC,OAAO,CAAM,EAAE,CAAC;QAChB,eAAM,CAAC,OAAO,CAAC,qDAAqD,IAAA,2BAAe,EAAC,CAAC,CAAC,EAAE,CAAC,CAAC;QAC1F,OAAO,SAAS,CAAC;IACnB,CAAC;AACH,CAAC;AAED,SAAS,eAAe,CAAC,IAAiB,EAAE,KAAc;IACxD,IAAI,CAAC;QACH,IAAI,CAAC,SAAS,CAAC;YACb,MAAM,EAAE,OAAO;YACf,KAAK,EAAE,IAAA,mBAAO,EAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS;SAC1C,CAAC,CAAC;QACH,IAAI,IAAA,0BAAW,EAAC,KAAK,CAAC,IAAI,KAAK,CAAC,UAAU,EAAE,CAAC;YAC3C,IAAI,CAAC,YAAY,CAAC,kBAAkB,EAAE,KAAK,CAAC,UAAU,CAAC,CAAC;QAC1D,CAAC;QACD,IAAI,CAAC,GAAG,EAAE,CAAC;IACb,CAAC;IAAC,OAAO,CAAM,EAAE,CAAC;QAChB,eAAM,CAAC,OAAO,CAAC,qDAAqD,IAAA,2BAAe,EAAC,CAAC,CAAC,EAAE,CAAC,CAAC;IAC5F,CAAC;AACH,CAAC;AAED,SAAS,kBAAkB,CAAC,IAAiB,EAAE,QAA0B;IACvE,IAAI,CAAC;QACH,IAAI,CAAC,YAAY,CAAC,kBAAkB,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAC;QACvD,MAAM,gBAAgB,GAAG,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,iBAAiB,CAAC,CAAC;QACjE,IAAI,gBAAgB,EAAE,CAAC;YACrB,IAAI,CAAC,YAAY,CAAC,kBAAkB,EAAE,gBAAgB,CAAC,CAAC;QAC1D,CAAC;QACD,IAAI,CAAC,SAAS,CAAC;YACb,MAAM,EAAE,SAAS;SAClB,CAAC,CAAC;QACH,IAAI,CAAC,GAAG,EAAE,CAAC;IACb,CAAC;IAAC,OAAO,CAAM,EAAE,CAAC;QAChB,eAAM,CAAC,OAAO,CAAC,qDAAqD,IAAA,2BAAe,EAAC,CAAC,CAAC,EAAE,CAAC,CAAC;IAC5F,CAAC;AACH,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport {\n type TracingClient,\n type TracingContext,\n type TracingSpan,\n createTracingClient,\n} from \"@azure/core-tracing\";\nimport { SDK_VERSION } from \"../constants.js\";\nimport type { PipelineRequest, PipelineResponse, SendRequest } from \"../interfaces.js\";\nimport type { PipelinePolicy } from \"../pipeline.js\";\nimport { getUserAgentValue } from \"../util/userAgent.js\";\nimport { logger } from \"../log.js\";\nimport { getErrorMessage, isError } from \"@azure/core-util\";\nimport { isRestError } from \"../restError.js\";\nimport { Sanitizer } from \"../util/sanitizer.js\";\n\n/**\n * The programmatic identifier of the tracingPolicy.\n */\nexport const tracingPolicyName = \"tracingPolicy\";\n\n/**\n * Options to configure the tracing policy.\n */\nexport interface TracingPolicyOptions {\n /**\n * String prefix to add to the user agent logged as metadata\n * on the generated Span.\n * Defaults to an empty string.\n */\n userAgentPrefix?: string;\n /**\n * Query string names whose values will be logged when logging is enabled. By default no\n * query string values are logged.\n */\n additionalAllowedQueryParameters?: string[];\n}\n\n/**\n * A simple policy to create OpenTelemetry Spans for each request made by the pipeline\n * that has SpanOptions with a parent.\n * Requests made without a parent Span will not be recorded.\n * @param options - Options to configure the telemetry logged by the tracing policy.\n */\nexport function tracingPolicy(options: TracingPolicyOptions = {}): PipelinePolicy {\n const userAgentPromise = getUserAgentValue(options.userAgentPrefix);\n const sanitizer = new Sanitizer({\n additionalAllowedQueryParameters: options.additionalAllowedQueryParameters,\n });\n const tracingClient = tryCreateTracingClient();\n\n return {\n name: tracingPolicyName,\n async sendRequest(request: PipelineRequest, next: SendRequest): Promise {\n if (!tracingClient) {\n return next(request);\n }\n\n const userAgent = await userAgentPromise;\n\n const spanAttributes = {\n \"http.url\": sanitizer.sanitizeUrl(request.url),\n \"http.method\": request.method,\n \"http.user_agent\": userAgent,\n requestId: request.requestId,\n };\n if (userAgent) {\n spanAttributes[\"http.user_agent\"] = userAgent;\n }\n\n const { span, tracingContext } = tryCreateSpan(tracingClient, request, spanAttributes) ?? {};\n\n if (!span || !tracingContext) {\n return next(request);\n }\n\n try {\n const response = await tracingClient.withContext(tracingContext, next, request);\n tryProcessResponse(span, response);\n return response;\n } catch (err: any) {\n tryProcessError(span, err);\n throw err;\n }\n },\n };\n}\n\nfunction tryCreateTracingClient(): TracingClient | undefined {\n try {\n return createTracingClient({\n namespace: \"\",\n packageName: \"@azure/core-rest-pipeline\",\n packageVersion: SDK_VERSION,\n });\n } catch (e: unknown) {\n logger.warning(`Error when creating the TracingClient: ${getErrorMessage(e)}`);\n return undefined;\n }\n}\n\nfunction tryCreateSpan(\n tracingClient: TracingClient,\n request: PipelineRequest,\n spanAttributes: Record,\n): { span: TracingSpan; tracingContext: TracingContext } | undefined {\n try {\n // As per spec, we do not need to differentiate between HTTP and HTTPS in span name.\n const { span, updatedOptions } = tracingClient.startSpan(\n `HTTP ${request.method}`,\n { tracingOptions: request.tracingOptions },\n {\n spanKind: \"client\",\n spanAttributes,\n },\n );\n\n // If the span is not recording, don't do any more work.\n if (!span.isRecording()) {\n span.end();\n return undefined;\n }\n\n // set headers\n const headers = tracingClient.createRequestHeaders(\n updatedOptions.tracingOptions.tracingContext,\n );\n for (const [key, value] of Object.entries(headers)) {\n request.headers.set(key, value);\n }\n return { span, tracingContext: updatedOptions.tracingOptions.tracingContext };\n } catch (e: any) {\n logger.warning(`Skipping creating a tracing span due to an error: ${getErrorMessage(e)}`);\n return undefined;\n }\n}\n\nfunction tryProcessError(span: TracingSpan, error: unknown): void {\n try {\n span.setStatus({\n status: \"error\",\n error: isError(error) ? error : undefined,\n });\n if (isRestError(error) && error.statusCode) {\n span.setAttribute(\"http.status_code\", error.statusCode);\n }\n span.end();\n } catch (e: any) {\n logger.warning(`Skipping tracing span processing due to an error: ${getErrorMessage(e)}`);\n }\n}\n\nfunction tryProcessResponse(span: TracingSpan, response: PipelineResponse): void {\n try {\n span.setAttribute(\"http.status_code\", response.status);\n const serviceRequestId = response.headers.get(\"x-ms-request-id\");\n if (serviceRequestId) {\n span.setAttribute(\"serviceRequestId\", serviceRequestId);\n }\n span.setStatus({\n status: \"success\",\n });\n span.end();\n } catch (e: any) {\n logger.warning(`Skipping tracing span processing due to an error: ${getErrorMessage(e)}`);\n }\n}\n"]} \ No newline at end of file +{"version":3,"file":"tracingPolicy.js","sourceRoot":"","sources":["../../../src/policies/tracingPolicy.ts"],"names":[],"mappings":";AAAA,uCAAuC;AACvC,kCAAkC;;;AA6ClC,sCA0CC;AArFD,sDAK6B;AAC7B,kDAA8C;AAG9C,uDAAyD;AACzD,sCAAmC;AACnC,gDAA4D;AAC5D,kDAA8C;AAC9C,uDAAiD;AAEjD;;GAEG;AACU,QAAA,iBAAiB,GAAG,eAAe,CAAC;AAmBjD;;;;;GAKG;AACH,SAAgB,aAAa,CAAC,UAAgC,EAAE;IAC9D,MAAM,gBAAgB,GAAG,IAAA,gCAAiB,EAAC,OAAO,CAAC,eAAe,CAAC,CAAC;IACpE,MAAM,SAAS,GAAG,IAAI,wBAAS,CAAC;QAC9B,gCAAgC,EAAE,OAAO,CAAC,gCAAgC;KAC3E,CAAC,CAAC;IACH,MAAM,aAAa,GAAG,sBAAsB,EAAE,CAAC;IAE/C,OAAO;QACL,IAAI,EAAE,yBAAiB;QACvB,KAAK,CAAC,WAAW,CAAC,OAAwB,EAAE,IAAiB;;YAC3D,IAAI,CAAC,aAAa,EAAE,CAAC;gBACnB,OAAO,IAAI,CAAC,OAAO,CAAC,CAAC;YACvB,CAAC;YAED,MAAM,SAAS,GAAG,MAAM,gBAAgB,CAAC;YAEzC,MAAM,cAAc,GAAG;gBACrB,UAAU,EAAE,SAAS,CAAC,WAAW,CAAC,OAAO,CAAC,GAAG,CAAC;gBAC9C,aAAa,EAAE,OAAO,CAAC,MAAM;gBAC7B,iBAAiB,EAAE,SAAS;gBAC5B,SAAS,EAAE,OAAO,CAAC,SAAS;aAC7B,CAAC;YACF,IAAI,SAAS,EAAE,CAAC;gBACd,cAAc,CAAC,iBAAiB,CAAC,GAAG,SAAS,CAAC;YAChD,CAAC;YAED,MAAM,EAAE,IAAI,EAAE,cAAc,EAAE,GAAG,MAAA,aAAa,CAAC,aAAa,EAAE,OAAO,EAAE,cAAc,CAAC,mCAAI,EAAE,CAAC;YAE7F,IAAI,CAAC,IAAI,IAAI,CAAC,cAAc,EAAE,CAAC;gBAC7B,OAAO,IAAI,CAAC,OAAO,CAAC,CAAC;YACvB,CAAC;YAED,IAAI,CAAC;gBACH,MAAM,QAAQ,GAAG,MAAM,aAAa,CAAC,WAAW,CAAC,cAAc,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;gBAChF,kBAAkB,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;gBACnC,OAAO,QAAQ,CAAC;YAClB,CAAC;YAAC,OAAO,GAAQ,EAAE,CAAC;gBAClB,eAAe,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;gBAC3B,MAAM,GAAG,CAAC;YACZ,CAAC;QACH,CAAC;KACF,CAAC;AACJ,CAAC;AAED,SAAS,sBAAsB;IAC7B,IAAI,CAAC;QACH,OAAO,IAAA,kCAAmB,EAAC;YACzB,SAAS,EAAE,EAAE;YACb,WAAW,EAAE,2BAA2B;YACxC,cAAc,EAAE,0BAAW;SAC5B,CAAC,CAAC;IACL,CAAC;IAAC,OAAO,CAAU,EAAE,CAAC;QACpB,eAAM,CAAC,OAAO,CAAC,0CAA0C,IAAA,2BAAe,EAAC,CAAC,CAAC,EAAE,CAAC,CAAC;QAC/E,OAAO,SAAS,CAAC;IACnB,CAAC;AACH,CAAC;AAED,SAAS,aAAa,CACpB,aAA4B,EAC5B,OAAwB,EACxB,cAAuC;IAEvC,IAAI,CAAC;QACH,oFAAoF;QACpF,MAAM,EAAE,IAAI,EAAE,cAAc,EAAE,GAAG,aAAa,CAAC,SAAS,CACtD,QAAQ,OAAO,CAAC,MAAM,EAAE,EACxB,EAAE,cAAc,EAAE,OAAO,CAAC,cAAc,EAAE,EAC1C;YACE,QAAQ,EAAE,QAAQ;YAClB,cAAc;SACf,CACF,CAAC;QAEF,wDAAwD;QACxD,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,EAAE,CAAC;YACxB,IAAI,CAAC,GAAG,EAAE,CAAC;YACX,OAAO,SAAS,CAAC;QACnB,CAAC;QAED,cAAc;QACd,MAAM,OAAO,GAAG,aAAa,CAAC,oBAAoB,CAChD,cAAc,CAAC,cAAc,CAAC,cAAc,CAC7C,CAAC;QACF,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC;YACnD,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;QAClC,CAAC;QACD,OAAO,EAAE,IAAI,EAAE,cAAc,EAAE,cAAc,CAAC,cAAc,CAAC,cAAc,EAAE,CAAC;IAChF,CAAC;IAAC,OAAO,CAAM,EAAE,CAAC;QAChB,eAAM,CAAC,OAAO,CAAC,qDAAqD,IAAA,2BAAe,EAAC,CAAC,CAAC,EAAE,CAAC,CAAC;QAC1F,OAAO,SAAS,CAAC;IACnB,CAAC;AACH,CAAC;AAED,SAAS,eAAe,CAAC,IAAiB,EAAE,KAAc;IACxD,IAAI,CAAC;QACH,IAAI,CAAC,SAAS,CAAC;YACb,MAAM,EAAE,OAAO;YACf,KAAK,EAAE,IAAA,mBAAO,EAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS;SAC1C,CAAC,CAAC;QACH,IAAI,IAAA,0BAAW,EAAC,KAAK,CAAC,IAAI,KAAK,CAAC,UAAU,EAAE,CAAC;YAC3C,IAAI,CAAC,YAAY,CAAC,kBAAkB,EAAE,KAAK,CAAC,UAAU,CAAC,CAAC;QAC1D,CAAC;QACD,IAAI,CAAC,GAAG,EAAE,CAAC;IACb,CAAC;IAAC,OAAO,CAAM,EAAE,CAAC;QAChB,eAAM,CAAC,OAAO,CAAC,qDAAqD,IAAA,2BAAe,EAAC,CAAC,CAAC,EAAE,CAAC,CAAC;IAC5F,CAAC;AACH,CAAC;AAED,SAAS,kBAAkB,CAAC,IAAiB,EAAE,QAA0B;IACvE,IAAI,CAAC;QACH,IAAI,CAAC,YAAY,CAAC,kBAAkB,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAC;QACvD,MAAM,gBAAgB,GAAG,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,iBAAiB,CAAC,CAAC;QACjE,IAAI,gBAAgB,EAAE,CAAC;YACrB,IAAI,CAAC,YAAY,CAAC,kBAAkB,EAAE,gBAAgB,CAAC,CAAC;QAC1D,CAAC;QACD,2FAA2F;QAC3F,2CAA2C;QAC3C,sEAAsE;QACtE,IAAI,QAAQ,CAAC,MAAM,IAAI,GAAG,EAAE,CAAC;YAC3B,IAAI,CAAC,SAAS,CAAC;gBACb,MAAM,EAAE,OAAO;aAChB,CAAC,CAAC;QACL,CAAC;QACD,IAAI,CAAC,GAAG,EAAE,CAAC;IACb,CAAC;IAAC,OAAO,CAAM,EAAE,CAAC;QAChB,eAAM,CAAC,OAAO,CAAC,qDAAqD,IAAA,2BAAe,EAAC,CAAC,CAAC,EAAE,CAAC,CAAC;IAC5F,CAAC;AACH,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport {\n type TracingClient,\n type TracingContext,\n type TracingSpan,\n createTracingClient,\n} from \"@azure/core-tracing\";\nimport { SDK_VERSION } from \"../constants.js\";\nimport type { PipelineRequest, PipelineResponse, SendRequest } from \"../interfaces.js\";\nimport type { PipelinePolicy } from \"../pipeline.js\";\nimport { getUserAgentValue } from \"../util/userAgent.js\";\nimport { logger } from \"../log.js\";\nimport { getErrorMessage, isError } from \"@azure/core-util\";\nimport { isRestError } from \"../restError.js\";\nimport { Sanitizer } from \"../util/sanitizer.js\";\n\n/**\n * The programmatic identifier of the tracingPolicy.\n */\nexport const tracingPolicyName = \"tracingPolicy\";\n\n/**\n * Options to configure the tracing policy.\n */\nexport interface TracingPolicyOptions {\n /**\n * String prefix to add to the user agent logged as metadata\n * on the generated Span.\n * Defaults to an empty string.\n */\n userAgentPrefix?: string;\n /**\n * Query string names whose values will be logged when logging is enabled. By default no\n * query string values are logged.\n */\n additionalAllowedQueryParameters?: string[];\n}\n\n/**\n * A simple policy to create OpenTelemetry Spans for each request made by the pipeline\n * that has SpanOptions with a parent.\n * Requests made without a parent Span will not be recorded.\n * @param options - Options to configure the telemetry logged by the tracing policy.\n */\nexport function tracingPolicy(options: TracingPolicyOptions = {}): PipelinePolicy {\n const userAgentPromise = getUserAgentValue(options.userAgentPrefix);\n const sanitizer = new Sanitizer({\n additionalAllowedQueryParameters: options.additionalAllowedQueryParameters,\n });\n const tracingClient = tryCreateTracingClient();\n\n return {\n name: tracingPolicyName,\n async sendRequest(request: PipelineRequest, next: SendRequest): Promise {\n if (!tracingClient) {\n return next(request);\n }\n\n const userAgent = await userAgentPromise;\n\n const spanAttributes = {\n \"http.url\": sanitizer.sanitizeUrl(request.url),\n \"http.method\": request.method,\n \"http.user_agent\": userAgent,\n requestId: request.requestId,\n };\n if (userAgent) {\n spanAttributes[\"http.user_agent\"] = userAgent;\n }\n\n const { span, tracingContext } = tryCreateSpan(tracingClient, request, spanAttributes) ?? {};\n\n if (!span || !tracingContext) {\n return next(request);\n }\n\n try {\n const response = await tracingClient.withContext(tracingContext, next, request);\n tryProcessResponse(span, response);\n return response;\n } catch (err: any) {\n tryProcessError(span, err);\n throw err;\n }\n },\n };\n}\n\nfunction tryCreateTracingClient(): TracingClient | undefined {\n try {\n return createTracingClient({\n namespace: \"\",\n packageName: \"@azure/core-rest-pipeline\",\n packageVersion: SDK_VERSION,\n });\n } catch (e: unknown) {\n logger.warning(`Error when creating the TracingClient: ${getErrorMessage(e)}`);\n return undefined;\n }\n}\n\nfunction tryCreateSpan(\n tracingClient: TracingClient,\n request: PipelineRequest,\n spanAttributes: Record,\n): { span: TracingSpan; tracingContext: TracingContext } | undefined {\n try {\n // As per spec, we do not need to differentiate between HTTP and HTTPS in span name.\n const { span, updatedOptions } = tracingClient.startSpan(\n `HTTP ${request.method}`,\n { tracingOptions: request.tracingOptions },\n {\n spanKind: \"client\",\n spanAttributes,\n },\n );\n\n // If the span is not recording, don't do any more work.\n if (!span.isRecording()) {\n span.end();\n return undefined;\n }\n\n // set headers\n const headers = tracingClient.createRequestHeaders(\n updatedOptions.tracingOptions.tracingContext,\n );\n for (const [key, value] of Object.entries(headers)) {\n request.headers.set(key, value);\n }\n return { span, tracingContext: updatedOptions.tracingOptions.tracingContext };\n } catch (e: any) {\n logger.warning(`Skipping creating a tracing span due to an error: ${getErrorMessage(e)}`);\n return undefined;\n }\n}\n\nfunction tryProcessError(span: TracingSpan, error: unknown): void {\n try {\n span.setStatus({\n status: \"error\",\n error: isError(error) ? error : undefined,\n });\n if (isRestError(error) && error.statusCode) {\n span.setAttribute(\"http.status_code\", error.statusCode);\n }\n span.end();\n } catch (e: any) {\n logger.warning(`Skipping tracing span processing due to an error: ${getErrorMessage(e)}`);\n }\n}\n\nfunction tryProcessResponse(span: TracingSpan, response: PipelineResponse): void {\n try {\n span.setAttribute(\"http.status_code\", response.status);\n const serviceRequestId = response.headers.get(\"x-ms-request-id\");\n if (serviceRequestId) {\n span.setAttribute(\"serviceRequestId\", serviceRequestId);\n }\n // Per semantic conventions, only set the status to error if the status code is 4xx or 5xx.\n // Otherwise, the status MUST remain unset.\n // https://opentelemetry.io/docs/specs/semconv/http/http-spans/#status\n if (response.status >= 400) {\n span.setStatus({\n status: \"error\",\n });\n }\n span.end();\n } catch (e: any) {\n logger.warning(`Skipping tracing span processing due to an error: ${getErrorMessage(e)}`);\n }\n}\n"]} \ No newline at end of file diff --git a/node_modules/@azure/core-rest-pipeline/dist/commonjs/restError.d.ts b/node_modules/@azure/core-rest-pipeline/dist/commonjs/restError.d.ts index 0bb2fc48..66264448 100644 --- a/node_modules/@azure/core-rest-pipeline/dist/commonjs/restError.d.ts +++ b/node_modules/@azure/core-rest-pipeline/dist/commonjs/restError.d.ts @@ -24,6 +24,7 @@ export interface RestErrorOptions { * A custom error type for failed pipeline requests. */ export declare class RestError extends Error { + [x: symbol]: () => string; /** * Something went wrong when making the request. * This means the actual request failed for some reason, diff --git a/node_modules/@azure/core-rest-pipeline/dist/commonjs/restError.d.ts.map b/node_modules/@azure/core-rest-pipeline/dist/commonjs/restError.d.ts.map index d6e29e6c..a10965e3 100644 --- a/node_modules/@azure/core-rest-pipeline/dist/commonjs/restError.d.ts.map +++ b/node_modules/@azure/core-rest-pipeline/dist/commonjs/restError.d.ts.map @@ -1 +1 @@ -{"version":3,"file":"restError.d.ts","sourceRoot":"","sources":["../../src/restError.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,eAAe,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAC;AAMzE;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,OAAO,CAAC,EAAE,eAAe,CAAC;IAC1B;;OAEG;IACH,QAAQ,CAAC,EAAE,gBAAgB,CAAC;CAC7B;AAED;;GAEG;AACH,qBAAa,SAAU,SAAQ,KAAK;IAClC;;;;OAIG;IACH,MAAM,CAAC,QAAQ,CAAC,kBAAkB,EAAE,MAAM,CAAwB;IAClE;;;OAGG;IACH,MAAM,CAAC,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAiB;IAEpD;;OAEG;IACI,IAAI,CAAC,EAAE,MAAM,CAAC;IACrB;;OAEG;IACI,UAAU,CAAC,EAAE,MAAM,CAAC;IAC3B;;;OAGG;IACI,OAAO,CAAC,EAAE,eAAe,CAAC;IACjC;;;OAGG;IACI,QAAQ,CAAC,EAAE,gBAAgB,CAAC;IACnC;;OAEG;IACI,OAAO,CAAC,EAAE,OAAO,CAAC;gBAEb,OAAO,EAAE,MAAM,EAAE,OAAO,GAAE,gBAAqB;CA4B5D;AAED;;;GAGG;AACH,wBAAgB,WAAW,CAAC,CAAC,EAAE,OAAO,GAAG,CAAC,IAAI,SAAS,CAKtD"} \ No newline at end of file +{"version":3,"file":"restError.d.ts","sourceRoot":"","sources":["../../src/restError.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,eAAe,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAC;AAMzE;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,OAAO,CAAC,EAAE,eAAe,CAAC;IAC1B;;OAEG;IACH,QAAQ,CAAC,EAAE,gBAAgB,CAAC;CAC7B;AAED;;GAEG;AACH,qBAAa,SAAU,SAAQ,KAAK;uBAuDtB,MAAM;IAtDlB;;;;OAIG;IACH,MAAM,CAAC,QAAQ,CAAC,kBAAkB,EAAE,MAAM,CAAwB;IAClE;;;OAGG;IACH,MAAM,CAAC,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAiB;IAEpD;;OAEG;IACI,IAAI,CAAC,EAAE,MAAM,CAAC;IACrB;;OAEG;IACI,UAAU,CAAC,EAAE,MAAM,CAAC;IAC3B;;;OAGG;IACI,OAAO,CAAC,EAAE,eAAe,CAAC;IACjC;;;OAGG;IACI,QAAQ,CAAC,EAAE,gBAAgB,CAAC;IACnC;;OAEG;IACI,OAAO,CAAC,EAAE,OAAO,CAAC;gBAEb,OAAO,EAAE,MAAM,EAAE,OAAO,GAAE,gBAAqB;CA4B5D;AAED;;;GAGG;AACH,wBAAgB,WAAW,CAAC,CAAC,EAAE,OAAO,GAAG,CAAC,IAAI,SAAS,CAKtD"} \ No newline at end of file diff --git a/node_modules/@azure/core-rest-pipeline/dist/commonjs/tsdoc-metadata.json b/node_modules/@azure/core-rest-pipeline/dist/commonjs/tsdoc-metadata.json index 036af567..7cd96703 100644 --- a/node_modules/@azure/core-rest-pipeline/dist/commonjs/tsdoc-metadata.json +++ b/node_modules/@azure/core-rest-pipeline/dist/commonjs/tsdoc-metadata.json @@ -5,7 +5,7 @@ "toolPackages": [ { "packageName": "@microsoft/api-extractor", - "packageVersion": "7.48.0" + "packageVersion": "7.48.1" } ] } diff --git a/node_modules/@azure/core-rest-pipeline/dist/commonjs/util/file.d.ts.map b/node_modules/@azure/core-rest-pipeline/dist/commonjs/util/file.d.ts.map index 092797aa..d165dbda 100644 --- a/node_modules/@azure/core-rest-pipeline/dist/commonjs/util/file.d.ts.map +++ b/node_modules/@azure/core-rest-pipeline/dist/commonjs/util/file.d.ts.map @@ -1 +1 @@ -{"version":3,"file":"file.d.ts","sourceRoot":"","sources":["../../../src/util/file.ts"],"names":[],"mappings":"AAMA;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAC7B;AAED;;GAEG;AACH,MAAM,WAAW,2BAA4B,SAAQ,iBAAiB;IACpE;;;;;OAKG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAyCD;;;;;;GAMG;AACH,wBAAgB,aAAa,CAC3B,IAAI,EAAE,IAAI,GACT,MAAM,CAAC,cAAc,GAAG,cAAc,CAAC,UAAU,CAAC,GAAG,UAAU,CAMjE;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,oBAAoB,CAClC,MAAM,EAAE,MAAM,cAAc,CAAC,UAAU,CAAC,GAAG,MAAM,CAAC,cAAc,EAChE,IAAI,EAAE,MAAM,EACZ,OAAO,GAAE,2BAAgC,GACxC,IAAI,CAoBN;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,UAAU,CACxB,OAAO,EAAE,UAAU,EACnB,IAAI,EAAE,MAAM,EACZ,OAAO,GAAE,iBAAsB,GAC9B,IAAI,CAgBN"} \ No newline at end of file +{"version":3,"file":"file.d.ts","sourceRoot":"","sources":["../../../src/util/file.ts"],"names":[],"mappings":"AAMA;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAC7B;AAED;;GAEG;AACH,MAAM,WAAW,2BAA4B,SAAQ,iBAAiB;IACpE;;;;;OAKG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AA4CD;;;;;;GAMG;AACH,wBAAgB,aAAa,CAC3B,IAAI,EAAE,IAAI,GACT,MAAM,CAAC,cAAc,GAAG,cAAc,CAAC,UAAU,CAAC,GAAG,UAAU,CAMjE;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,oBAAoB,CAClC,MAAM,EAAE,MAAM,cAAc,CAAC,UAAU,CAAC,GAAG,MAAM,CAAC,cAAc,EAChE,IAAI,EAAE,MAAM,EACZ,OAAO,GAAE,2BAAgC,GACxC,IAAI,CAoBN;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,UAAU,CACxB,OAAO,EAAE,UAAU,EACnB,IAAI,EAAE,MAAM,EACZ,OAAO,GAAE,iBAAsB,GAC9B,IAAI,CAgBN"} \ No newline at end of file diff --git a/node_modules/@azure/core-rest-pipeline/dist/commonjs/util/file.js b/node_modules/@azure/core-rest-pipeline/dist/commonjs/util/file.js index d0f58f96..b67a2362 100644 --- a/node_modules/@azure/core-rest-pipeline/dist/commonjs/util/file.js +++ b/node_modules/@azure/core-rest-pipeline/dist/commonjs/util/file.js @@ -11,6 +11,9 @@ const unimplementedMethods = { arrayBuffer: () => { throw new Error("Not implemented"); }, + bytes: () => { + throw new Error("Not implemented"); + }, slice: () => { throw new Error("Not implemented"); }, diff --git a/node_modules/@azure/core-rest-pipeline/dist/commonjs/util/file.js.map b/node_modules/@azure/core-rest-pipeline/dist/commonjs/util/file.js.map index f3b0c4a9..604026ae 100644 --- a/node_modules/@azure/core-rest-pipeline/dist/commonjs/util/file.js.map +++ b/node_modules/@azure/core-rest-pipeline/dist/commonjs/util/file.js.map @@ -1 +1 @@ -{"version":3,"file":"file.js","sourceRoot":"","sources":["../../../src/util/file.ts"],"names":[],"mappings":";AAAA,uCAAuC;AACvC,kCAAkC;;AAqFlC,sCAQC;AAmBD,oDAwBC;AAaD,gCAoBC;AAvKD,gDAA8C;AAC9C,mDAAuD;AAoCvD,MAAM,oBAAoB,GAAG;IAC3B,WAAW,EAAE,GAAG,EAAE;QAChB,MAAM,IAAI,KAAK,CAAC,iBAAiB,CAAC,CAAC;IACrC,CAAC;IACD,KAAK,EAAE,GAAG,EAAE;QACV,MAAM,IAAI,KAAK,CAAC,iBAAiB,CAAC,CAAC;IACrC,CAAC;IACD,IAAI,EAAE,GAAG,EAAE;QACT,MAAM,IAAI,KAAK,CAAC,iBAAiB,CAAC,CAAC;IACrC,CAAC;CACF,CAAC;AAEF;;;;;;;;;;;;;GAaG;AACH,MAAM,UAAU,GAAkB,MAAM,CAAC,YAAY,CAAC,CAAC;AASvD,SAAS,aAAa,CAAC,CAAU;IAC/B,OAAO,OAAQ,CAAgB,CAAC,UAAU,CAAC,KAAK,UAAU,CAAC;AAC7D,CAAC;AAED;;;;;;GAMG;AACH,SAAgB,aAAa,CAC3B,IAAU;IAEV,IAAI,aAAa,CAAC,IAAI,CAAC,EAAE,CAAC;QACxB,OAAO,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC;IAC5B,CAAC;SAAM,CAAC;QACN,OAAO,IAAI,CAAC,MAAM,EAAE,CAAC;IACvB,CAAC;AACH,CAAC;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,SAAgB,oBAAoB,CAClC,MAAgE,EAChE,IAAY,EACZ,UAAuC,EAAE;;IAEzC,OAAO,gCACF,oBAAoB,KACvB,IAAI,EAAE,MAAA,OAAO,CAAC,IAAI,mCAAI,EAAE,EACxB,YAAY,EAAE,MAAA,OAAO,CAAC,YAAY,mCAAI,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,EAC1D,kBAAkB,EAAE,MAAA,OAAO,CAAC,kBAAkB,mCAAI,EAAE,EACpD,IAAI,EAAE,MAAA,OAAO,CAAC,IAAI,mCAAI,CAAC,CAAC,EACxB,IAAI,EACJ,MAAM,EAAE,GAAG,EAAE;YACX,MAAM,CAAC,GAAG,MAAM,EAAE,CAAC;YACnB,IAAI,IAAA,oCAAoB,EAAC,CAAC,CAAC,EAAE,CAAC;gBAC5B,MAAM,IAAI,KAAK,CACb,6EAA6E,CAC9E,CAAC;YACJ,CAAC;YAED,OAAO,CAAC,CAAC;QACX,CAAC,EACD,CAAC,UAAU,CAAC,EAAE,MAAM,GACA,CAAC;AACzB,CAAC;AAED;;;;;;;;;;GAUG;AACH,SAAgB,UAAU,CACxB,OAAmB,EACnB,IAAY,EACZ,UAA6B,EAAE;;IAE/B,IAAI,sBAAU,EAAE,CAAC;QACf,OAAO,gCACF,oBAAoB,KACvB,IAAI,EAAE,MAAA,OAAO,CAAC,IAAI,mCAAI,EAAE,EACxB,YAAY,EAAE,MAAA,OAAO,CAAC,YAAY,mCAAI,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,EAC1D,kBAAkB,EAAE,MAAA,OAAO,CAAC,kBAAkB,mCAAI,EAAE,EACpD,IAAI,EAAE,OAAO,CAAC,UAAU,EACxB,IAAI,EACJ,WAAW,EAAE,KAAK,IAAI,EAAE,CAAC,OAAO,CAAC,MAAM,EACvC,MAAM,EAAE,GAAG,EAAE,CAAC,IAAI,IAAI,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,EAAE,EAC1C,CAAC,UAAU,CAAC,EAAE,GAAG,EAAE,CAAC,OAAO,GACP,CAAC;IACzB,CAAC;SAAM,CAAC;QACN,OAAO,IAAI,IAAI,CAAC,CAAC,OAAO,CAAC,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;IAC5C,CAAC;AACH,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport { isNodeLike } from \"@azure/core-util\";\nimport { isNodeReadableStream } from \"./typeGuards.js\";\n\n/**\n * Options passed into createFile specifying metadata about the file.\n */\nexport interface CreateFileOptions {\n /**\n * The MIME type of the file.\n */\n type?: string;\n\n /**\n * Last modified time of the file as a UNIX timestamp.\n * This will default to the current date.\n */\n lastModified?: number;\n\n /**\n * relative path of this file when uploading a directory.\n */\n webkitRelativePath?: string;\n}\n\n/**\n * Extra options for createFile when a stream is being passed in.\n */\nexport interface CreateFileFromStreamOptions extends CreateFileOptions {\n /**\n * Size of the file represented by the stream in bytes.\n *\n * This will be used by the pipeline when calculating the Content-Length header\n * for the overall request.\n */\n size?: number;\n}\n\nconst unimplementedMethods = {\n arrayBuffer: () => {\n throw new Error(\"Not implemented\");\n },\n slice: () => {\n throw new Error(\"Not implemented\");\n },\n text: () => {\n throw new Error(\"Not implemented\");\n },\n};\n\n/**\n * Private symbol used as key on objects created using createFile containing the\n * original source of the file object.\n *\n * This is used in Node to access the original Node stream without using Blob#stream, which\n * returns a web stream. This is done to avoid a couple of bugs to do with Blob#stream and\n * Readable#to/fromWeb in Node versions we support:\n * - https://github.com/nodejs/node/issues/42694 (fixed in Node 18.14)\n * - https://github.com/nodejs/node/issues/48916 (fixed in Node 20.6)\n *\n * Once these versions are no longer supported, we may be able to stop doing this.\n *\n * @internal\n */\nconst rawContent: unique symbol = Symbol(\"rawContent\");\n\n/**\n * Type signature of a blob-like object with a raw content property.\n */\ninterface RawContent {\n [rawContent](): Uint8Array | NodeJS.ReadableStream | ReadableStream;\n}\n\nfunction hasRawContent(x: unknown): x is RawContent {\n return typeof (x as RawContent)[rawContent] === \"function\";\n}\n\n/**\n * Extract the raw content from a given blob-like object. If the input was created using createFile\n * or createFileFromStream, the exact content passed into createFile/createFileFromStream will be used.\n * For true instances of Blob and File, returns the blob's content as a Web ReadableStream.\n *\n * @internal\n */\nexport function getRawContent(\n blob: Blob,\n): NodeJS.ReadableStream | ReadableStream | Uint8Array {\n if (hasRawContent(blob)) {\n return blob[rawContent]();\n } else {\n return blob.stream();\n }\n}\n\n/**\n * Create an object that implements the File interface. This object is intended to be\n * passed into RequestBodyType.formData, and is not guaranteed to work as expected in\n * other situations.\n *\n * Use this function to:\n * - Create a File object for use in RequestBodyType.formData in environments where the\n * global File object is unavailable.\n * - Create a File-like object from a readable stream without reading the stream into memory.\n *\n * @param stream - the content of the file as a callback returning a stream. When a File object made using createFile is\n * passed in a request's form data map, the stream will not be read into memory\n * and instead will be streamed when the request is made. In the event of a retry, the\n * stream needs to be read again, so this callback SHOULD return a fresh stream if possible.\n * @param name - the name of the file.\n * @param options - optional metadata about the file, e.g. file name, file size, MIME type.\n */\nexport function createFileFromStream(\n stream: () => ReadableStream | NodeJS.ReadableStream,\n name: string,\n options: CreateFileFromStreamOptions = {},\n): File {\n return {\n ...unimplementedMethods,\n type: options.type ?? \"\",\n lastModified: options.lastModified ?? new Date().getTime(),\n webkitRelativePath: options.webkitRelativePath ?? \"\",\n size: options.size ?? -1,\n name,\n stream: () => {\n const s = stream();\n if (isNodeReadableStream(s)) {\n throw new Error(\n \"Not supported: a Node stream was provided as input to createFileFromStream.\",\n );\n }\n\n return s;\n },\n [rawContent]: stream,\n } as File & RawContent;\n}\n\n/**\n * Create an object that implements the File interface. This object is intended to be\n * passed into RequestBodyType.formData, and is not guaranteed to work as expected in\n * other situations.\n *\n * Use this function create a File object for use in RequestBodyType.formData in environments where the global File object is unavailable.\n *\n * @param content - the content of the file as a Uint8Array in memory.\n * @param name - the name of the file.\n * @param options - optional metadata about the file, e.g. file name, file size, MIME type.\n */\nexport function createFile(\n content: Uint8Array,\n name: string,\n options: CreateFileOptions = {},\n): File {\n if (isNodeLike) {\n return {\n ...unimplementedMethods,\n type: options.type ?? \"\",\n lastModified: options.lastModified ?? new Date().getTime(),\n webkitRelativePath: options.webkitRelativePath ?? \"\",\n size: content.byteLength,\n name,\n arrayBuffer: async () => content.buffer,\n stream: () => new Blob([content]).stream(),\n [rawContent]: () => content,\n } as File & RawContent;\n } else {\n return new File([content], name, options);\n }\n}\n"]} \ No newline at end of file +{"version":3,"file":"file.js","sourceRoot":"","sources":["../../../src/util/file.ts"],"names":[],"mappings":";AAAA,uCAAuC;AACvC,kCAAkC;;AAwFlC,sCAQC;AAmBD,oDAwBC;AAaD,gCAoBC;AA1KD,gDAA8C;AAC9C,mDAAuD;AAoCvD,MAAM,oBAAoB,GAAG;IAC3B,WAAW,EAAE,GAAG,EAAE;QAChB,MAAM,IAAI,KAAK,CAAC,iBAAiB,CAAC,CAAC;IACrC,CAAC;IACD,KAAK,EAAE,GAAG,EAAE;QACV,MAAM,IAAI,KAAK,CAAC,iBAAiB,CAAC,CAAC;IACrC,CAAC;IACD,KAAK,EAAE,GAAG,EAAE;QACV,MAAM,IAAI,KAAK,CAAC,iBAAiB,CAAC,CAAC;IACrC,CAAC;IACD,IAAI,EAAE,GAAG,EAAE;QACT,MAAM,IAAI,KAAK,CAAC,iBAAiB,CAAC,CAAC;IACrC,CAAC;CACF,CAAC;AAEF;;;;;;;;;;;;;GAaG;AACH,MAAM,UAAU,GAAkB,MAAM,CAAC,YAAY,CAAC,CAAC;AASvD,SAAS,aAAa,CAAC,CAAU;IAC/B,OAAO,OAAQ,CAAgB,CAAC,UAAU,CAAC,KAAK,UAAU,CAAC;AAC7D,CAAC;AAED;;;;;;GAMG;AACH,SAAgB,aAAa,CAC3B,IAAU;IAEV,IAAI,aAAa,CAAC,IAAI,CAAC,EAAE,CAAC;QACxB,OAAO,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC;IAC5B,CAAC;SAAM,CAAC;QACN,OAAO,IAAI,CAAC,MAAM,EAAE,CAAC;IACvB,CAAC;AACH,CAAC;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,SAAgB,oBAAoB,CAClC,MAAgE,EAChE,IAAY,EACZ,UAAuC,EAAE;;IAEzC,OAAO,gCACF,oBAAoB,KACvB,IAAI,EAAE,MAAA,OAAO,CAAC,IAAI,mCAAI,EAAE,EACxB,YAAY,EAAE,MAAA,OAAO,CAAC,YAAY,mCAAI,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,EAC1D,kBAAkB,EAAE,MAAA,OAAO,CAAC,kBAAkB,mCAAI,EAAE,EACpD,IAAI,EAAE,MAAA,OAAO,CAAC,IAAI,mCAAI,CAAC,CAAC,EACxB,IAAI,EACJ,MAAM,EAAE,GAAG,EAAE;YACX,MAAM,CAAC,GAAG,MAAM,EAAE,CAAC;YACnB,IAAI,IAAA,oCAAoB,EAAC,CAAC,CAAC,EAAE,CAAC;gBAC5B,MAAM,IAAI,KAAK,CACb,6EAA6E,CAC9E,CAAC;YACJ,CAAC;YAED,OAAO,CAAC,CAAC;QACX,CAAC,EACD,CAAC,UAAU,CAAC,EAAE,MAAM,GACA,CAAC;AACzB,CAAC;AAED;;;;;;;;;;GAUG;AACH,SAAgB,UAAU,CACxB,OAAmB,EACnB,IAAY,EACZ,UAA6B,EAAE;;IAE/B,IAAI,sBAAU,EAAE,CAAC;QACf,OAAO,gCACF,oBAAoB,KACvB,IAAI,EAAE,MAAA,OAAO,CAAC,IAAI,mCAAI,EAAE,EACxB,YAAY,EAAE,MAAA,OAAO,CAAC,YAAY,mCAAI,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,EAC1D,kBAAkB,EAAE,MAAA,OAAO,CAAC,kBAAkB,mCAAI,EAAE,EACpD,IAAI,EAAE,OAAO,CAAC,UAAU,EACxB,IAAI,EACJ,WAAW,EAAE,KAAK,IAAI,EAAE,CAAC,OAAO,CAAC,MAAM,EACvC,MAAM,EAAE,GAAG,EAAE,CAAC,IAAI,IAAI,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,EAAE,EAC1C,CAAC,UAAU,CAAC,EAAE,GAAG,EAAE,CAAC,OAAO,GACP,CAAC;IACzB,CAAC;SAAM,CAAC;QACN,OAAO,IAAI,IAAI,CAAC,CAAC,OAAO,CAAC,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;IAC5C,CAAC;AACH,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport { isNodeLike } from \"@azure/core-util\";\nimport { isNodeReadableStream } from \"./typeGuards.js\";\n\n/**\n * Options passed into createFile specifying metadata about the file.\n */\nexport interface CreateFileOptions {\n /**\n * The MIME type of the file.\n */\n type?: string;\n\n /**\n * Last modified time of the file as a UNIX timestamp.\n * This will default to the current date.\n */\n lastModified?: number;\n\n /**\n * relative path of this file when uploading a directory.\n */\n webkitRelativePath?: string;\n}\n\n/**\n * Extra options for createFile when a stream is being passed in.\n */\nexport interface CreateFileFromStreamOptions extends CreateFileOptions {\n /**\n * Size of the file represented by the stream in bytes.\n *\n * This will be used by the pipeline when calculating the Content-Length header\n * for the overall request.\n */\n size?: number;\n}\n\nconst unimplementedMethods = {\n arrayBuffer: () => {\n throw new Error(\"Not implemented\");\n },\n bytes: () => {\n throw new Error(\"Not implemented\");\n },\n slice: () => {\n throw new Error(\"Not implemented\");\n },\n text: () => {\n throw new Error(\"Not implemented\");\n },\n};\n\n/**\n * Private symbol used as key on objects created using createFile containing the\n * original source of the file object.\n *\n * This is used in Node to access the original Node stream without using Blob#stream, which\n * returns a web stream. This is done to avoid a couple of bugs to do with Blob#stream and\n * Readable#to/fromWeb in Node versions we support:\n * - https://github.com/nodejs/node/issues/42694 (fixed in Node 18.14)\n * - https://github.com/nodejs/node/issues/48916 (fixed in Node 20.6)\n *\n * Once these versions are no longer supported, we may be able to stop doing this.\n *\n * @internal\n */\nconst rawContent: unique symbol = Symbol(\"rawContent\");\n\n/**\n * Type signature of a blob-like object with a raw content property.\n */\ninterface RawContent {\n [rawContent](): Uint8Array | NodeJS.ReadableStream | ReadableStream;\n}\n\nfunction hasRawContent(x: unknown): x is RawContent {\n return typeof (x as RawContent)[rawContent] === \"function\";\n}\n\n/**\n * Extract the raw content from a given blob-like object. If the input was created using createFile\n * or createFileFromStream, the exact content passed into createFile/createFileFromStream will be used.\n * For true instances of Blob and File, returns the blob's content as a Web ReadableStream.\n *\n * @internal\n */\nexport function getRawContent(\n blob: Blob,\n): NodeJS.ReadableStream | ReadableStream | Uint8Array {\n if (hasRawContent(blob)) {\n return blob[rawContent]();\n } else {\n return blob.stream();\n }\n}\n\n/**\n * Create an object that implements the File interface. This object is intended to be\n * passed into RequestBodyType.formData, and is not guaranteed to work as expected in\n * other situations.\n *\n * Use this function to:\n * - Create a File object for use in RequestBodyType.formData in environments where the\n * global File object is unavailable.\n * - Create a File-like object from a readable stream without reading the stream into memory.\n *\n * @param stream - the content of the file as a callback returning a stream. When a File object made using createFile is\n * passed in a request's form data map, the stream will not be read into memory\n * and instead will be streamed when the request is made. In the event of a retry, the\n * stream needs to be read again, so this callback SHOULD return a fresh stream if possible.\n * @param name - the name of the file.\n * @param options - optional metadata about the file, e.g. file name, file size, MIME type.\n */\nexport function createFileFromStream(\n stream: () => ReadableStream | NodeJS.ReadableStream,\n name: string,\n options: CreateFileFromStreamOptions = {},\n): File {\n return {\n ...unimplementedMethods,\n type: options.type ?? \"\",\n lastModified: options.lastModified ?? new Date().getTime(),\n webkitRelativePath: options.webkitRelativePath ?? \"\",\n size: options.size ?? -1,\n name,\n stream: () => {\n const s = stream();\n if (isNodeReadableStream(s)) {\n throw new Error(\n \"Not supported: a Node stream was provided as input to createFileFromStream.\",\n );\n }\n\n return s;\n },\n [rawContent]: stream,\n } as File & RawContent;\n}\n\n/**\n * Create an object that implements the File interface. This object is intended to be\n * passed into RequestBodyType.formData, and is not guaranteed to work as expected in\n * other situations.\n *\n * Use this function create a File object for use in RequestBodyType.formData in environments where the global File object is unavailable.\n *\n * @param content - the content of the file as a Uint8Array in memory.\n * @param name - the name of the file.\n * @param options - optional metadata about the file, e.g. file name, file size, MIME type.\n */\nexport function createFile(\n content: Uint8Array,\n name: string,\n options: CreateFileOptions = {},\n): File {\n if (isNodeLike) {\n return {\n ...unimplementedMethods,\n type: options.type ?? \"\",\n lastModified: options.lastModified ?? new Date().getTime(),\n webkitRelativePath: options.webkitRelativePath ?? \"\",\n size: content.byteLength,\n name,\n arrayBuffer: async () => content.buffer,\n stream: () => new Blob([content]).stream(),\n [rawContent]: () => content,\n } as File & RawContent;\n } else {\n return new File([content], name, options);\n }\n}\n"]} \ No newline at end of file diff --git a/node_modules/@azure/core-rest-pipeline/dist/esm/constants.js b/node_modules/@azure/core-rest-pipeline/dist/esm/constants.js index 6374dd08..f120876f 100644 --- a/node_modules/@azure/core-rest-pipeline/dist/esm/constants.js +++ b/node_modules/@azure/core-rest-pipeline/dist/esm/constants.js @@ -1,5 +1,5 @@ // Copyright (c) Microsoft Corporation. // Licensed under the MIT License. -export const SDK_VERSION = "1.18.1"; +export const SDK_VERSION = "1.18.2"; export const DEFAULT_RETRY_POLICY_COUNT = 3; //# sourceMappingURL=constants.js.map \ No newline at end of file diff --git a/node_modules/@azure/core-rest-pipeline/dist/esm/constants.js.map b/node_modules/@azure/core-rest-pipeline/dist/esm/constants.js.map index fc8b953a..9db3903f 100644 --- a/node_modules/@azure/core-rest-pipeline/dist/esm/constants.js.map +++ b/node_modules/@azure/core-rest-pipeline/dist/esm/constants.js.map @@ -1 +1 @@ -{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../src/constants.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAElC,MAAM,CAAC,MAAM,WAAW,GAAW,QAAQ,CAAC;AAE5C,MAAM,CAAC,MAAM,0BAA0B,GAAG,CAAC,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nexport const SDK_VERSION: string = \"1.18.1\";\n\nexport const DEFAULT_RETRY_POLICY_COUNT = 3;\n"]} \ No newline at end of file +{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../src/constants.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAElC,MAAM,CAAC,MAAM,WAAW,GAAW,QAAQ,CAAC;AAE5C,MAAM,CAAC,MAAM,0BAA0B,GAAG,CAAC,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nexport const SDK_VERSION: string = \"1.18.2\";\n\nexport const DEFAULT_RETRY_POLICY_COUNT = 3;\n"]} \ No newline at end of file diff --git a/node_modules/@azure/core-rest-pipeline/dist/esm/index.d.ts.map b/node_modules/@azure/core-rest-pipeline/dist/esm/index.d.ts.map index f8bb1e79..1f8d8a55 100644 --- a/node_modules/@azure/core-rest-pipeline/dist/esm/index.d.ts.map +++ b/node_modules/@azure/core-rest-pipeline/dist/esm/index.d.ts.map @@ -1 +1 @@ -{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAIA,OAAO,CAAC,MAAM,CAAC;IACb,UAAU,QAAQ;KAAG;IACrB,UAAU,IAAI;KAAG;IACjB,UAAU,IAAI;KAAG;IACjB,UAAU,cAAc,CAAC,CAAC,GAAG,GAAG;KAAI;IACpC,UAAU,eAAe,CAAC,CAAC,GAAG,GAAG,EAAE,CAAC,GAAG,GAAG;KAAI;CAC/C;AAGD,YAAY,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AACpD,YAAY,EACV,KAAK,EACL,QAAQ,EACR,WAAW,EACX,aAAa,EACb,UAAU,EACV,WAAW,EACX,SAAS,EACT,oBAAoB,EACpB,eAAe,EACf,gBAAgB,EAChB,oBAAoB,EACpB,aAAa,EACb,SAAS,EACT,cAAc,EACd,mBAAmB,EACnB,eAAe,EACf,WAAW,EACX,WAAW,EACX,qBAAqB,GACtB,MAAM,iBAAiB,CAAC;AACzB,OAAO,EACL,KAAK,gBAAgB,IAAI,kBAAkB,EAC3C,KAAK,aAAa,EAClB,KAAK,cAAc,EACnB,KAAK,QAAQ,EACb,mBAAmB,GACpB,MAAM,eAAe,CAAC;AACvB,OAAO,EACL,yBAAyB,EACzB,KAAK,gBAAgB,EACrB,KAAK,uBAAuB,EAC5B,KAAK,eAAe,GACrB,MAAM,gCAAgC,CAAC;AACxC,OAAO,EAAE,uBAAuB,EAAE,MAAM,wBAAwB,CAAC;AACjE,OAAO,EAAE,iBAAiB,EAAE,MAAM,kBAAkB,CAAC;AACrD,OAAO,EAAE,qBAAqB,EAAE,KAAK,sBAAsB,EAAE,MAAM,sBAAsB,CAAC;AAC1F,OAAO,EAAE,SAAS,EAAE,KAAK,gBAAgB,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAC/E,OAAO,EACL,wBAAwB,EACxB,4BAA4B,GAC7B,MAAM,wCAAwC,CAAC;AAChD,OAAO,EACL,sBAAsB,EACtB,KAAK,6BAA6B,EAClC,0BAA0B,GAC3B,MAAM,sCAAsC,CAAC;AAC9C,OAAO,EACL,wBAAwB,EACxB,4BAA4B,GAC7B,MAAM,wCAAwC,CAAC;AAChD,OAAO,EAAE,SAAS,EAAE,aAAa,EAAE,KAAK,gBAAgB,EAAE,MAAM,yBAAyB,CAAC;AAC1F,OAAO,EAAE,eAAe,EAAE,mBAAmB,EAAE,MAAM,+BAA+B,CAAC;AACrF,OAAO,EAAE,WAAW,EAAE,eAAe,EAAE,uBAAuB,EAAE,MAAM,2BAA2B,CAAC;AAClG,OAAO,EACL,cAAc,EACd,kBAAkB,EAClB,KAAK,qBAAqB,GAC3B,MAAM,8BAA8B,CAAC;AACtC,OAAO,EACL,sBAAsB,EACtB,KAAK,6BAA6B,EAClC,0BAA0B,GAC3B,MAAM,sCAAsC,CAAC;AAC9C,OAAO,EACL,qBAAqB,EACrB,yBAAyB,EACzB,KAAK,4BAA4B,GAClC,MAAM,qCAAqC,CAAC;AAC7C,OAAO,EAAE,WAAW,EAAE,KAAK,kBAAkB,EAAE,MAAM,2BAA2B,CAAC;AACjF,YAAY,EACV,aAAa,EACb,gBAAgB,EAChB,cAAc,GACf,MAAM,oCAAoC,CAAC;AAC5C,OAAO,EACL,aAAa,EACb,iBAAiB,EACjB,KAAK,oBAAoB,GAC1B,MAAM,6BAA6B,CAAC;AACrC,OAAO,EACL,kBAAkB,EAClB,KAAK,yBAAyB,GAC/B,MAAM,kCAAkC,CAAC;AAC1C,OAAO,EACL,eAAe,EACf,mBAAmB,EACnB,KAAK,sBAAsB,GAC5B,MAAM,+BAA+B,CAAC;AACvC,OAAO,EAAE,SAAS,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAC;AACnE,OAAO,EAAE,cAAc,EAAE,kBAAkB,EAAE,MAAM,8BAA8B,CAAC;AAClF,OAAO,EACL,+BAA+B,EAC/B,KAAK,sCAAsC,EAC3C,mCAAmC,EACnC,KAAK,kBAAkB,EACvB,KAAK,uBAAuB,EAC5B,KAAK,kCAAkC,GACxC,MAAM,+CAA+C,CAAC;AACvD,OAAO,EAAE,YAAY,EAAE,gBAAgB,EAAE,MAAM,4BAA4B,CAAC;AAC5E,OAAO,EACL,mCAAmC,EACnC,KAAK,0CAA0C,EAC/C,uCAAuC,GACxC,MAAM,mDAAmD,CAAC;AAC3D,OAAO,EACL,UAAU,EACV,oBAAoB,EACpB,KAAK,iBAAiB,EACtB,KAAK,2BAA2B,GACjC,MAAM,gBAAgB,CAAC"} \ No newline at end of file +{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAGA,OAAO,CAAC,MAAM,CAAC;IACb,UAAU,QAAQ;KAAG;IACrB,UAAU,IAAI;KAAG;IACjB,UAAU,IAAI;KAAG;IACjB,UAAU,cAAc,CAAC,CAAC,GAAG,GAAG;KAAI;IACpC,UAAU,eAAe,CAAC,CAAC,GAAG,GAAG,EAAE,CAAC,GAAG,GAAG;KAAI;CAC/C;AAED,YAAY,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AACpD,YAAY,EACV,KAAK,EACL,QAAQ,EACR,WAAW,EACX,aAAa,EACb,UAAU,EACV,WAAW,EACX,SAAS,EACT,oBAAoB,EACpB,eAAe,EACf,gBAAgB,EAChB,oBAAoB,EACpB,aAAa,EACb,SAAS,EACT,cAAc,EACd,mBAAmB,EACnB,eAAe,EACf,WAAW,EACX,WAAW,EACX,qBAAqB,GACtB,MAAM,iBAAiB,CAAC;AACzB,OAAO,EACL,KAAK,gBAAgB,IAAI,kBAAkB,EAC3C,KAAK,aAAa,EAClB,KAAK,cAAc,EACnB,KAAK,QAAQ,EACb,mBAAmB,GACpB,MAAM,eAAe,CAAC;AACvB,OAAO,EACL,yBAAyB,EACzB,KAAK,gBAAgB,EACrB,KAAK,uBAAuB,EAC5B,KAAK,eAAe,GACrB,MAAM,gCAAgC,CAAC;AACxC,OAAO,EAAE,uBAAuB,EAAE,MAAM,wBAAwB,CAAC;AACjE,OAAO,EAAE,iBAAiB,EAAE,MAAM,kBAAkB,CAAC;AACrD,OAAO,EAAE,qBAAqB,EAAE,KAAK,sBAAsB,EAAE,MAAM,sBAAsB,CAAC;AAC1F,OAAO,EAAE,SAAS,EAAE,KAAK,gBAAgB,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAC/E,OAAO,EACL,wBAAwB,EACxB,4BAA4B,GAC7B,MAAM,wCAAwC,CAAC;AAChD,OAAO,EACL,sBAAsB,EACtB,KAAK,6BAA6B,EAClC,0BAA0B,GAC3B,MAAM,sCAAsC,CAAC;AAC9C,OAAO,EACL,wBAAwB,EACxB,4BAA4B,GAC7B,MAAM,wCAAwC,CAAC;AAChD,OAAO,EAAE,SAAS,EAAE,aAAa,EAAE,KAAK,gBAAgB,EAAE,MAAM,yBAAyB,CAAC;AAC1F,OAAO,EAAE,eAAe,EAAE,mBAAmB,EAAE,MAAM,+BAA+B,CAAC;AACrF,OAAO,EAAE,WAAW,EAAE,eAAe,EAAE,uBAAuB,EAAE,MAAM,2BAA2B,CAAC;AAClG,OAAO,EACL,cAAc,EACd,kBAAkB,EAClB,KAAK,qBAAqB,GAC3B,MAAM,8BAA8B,CAAC;AACtC,OAAO,EACL,sBAAsB,EACtB,KAAK,6BAA6B,EAClC,0BAA0B,GAC3B,MAAM,sCAAsC,CAAC;AAC9C,OAAO,EACL,qBAAqB,EACrB,yBAAyB,EACzB,KAAK,4BAA4B,GAClC,MAAM,qCAAqC,CAAC;AAC7C,OAAO,EAAE,WAAW,EAAE,KAAK,kBAAkB,EAAE,MAAM,2BAA2B,CAAC;AACjF,YAAY,EACV,aAAa,EACb,gBAAgB,EAChB,cAAc,GACf,MAAM,oCAAoC,CAAC;AAC5C,OAAO,EACL,aAAa,EACb,iBAAiB,EACjB,KAAK,oBAAoB,GAC1B,MAAM,6BAA6B,CAAC;AACrC,OAAO,EACL,kBAAkB,EAClB,KAAK,yBAAyB,GAC/B,MAAM,kCAAkC,CAAC;AAC1C,OAAO,EACL,eAAe,EACf,mBAAmB,EACnB,KAAK,sBAAsB,GAC5B,MAAM,+BAA+B,CAAC;AACvC,OAAO,EAAE,SAAS,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAC;AACnE,OAAO,EAAE,cAAc,EAAE,kBAAkB,EAAE,MAAM,8BAA8B,CAAC;AAClF,OAAO,EACL,+BAA+B,EAC/B,KAAK,sCAAsC,EAC3C,mCAAmC,EACnC,KAAK,kBAAkB,EACvB,KAAK,uBAAuB,EAC5B,KAAK,kCAAkC,GACxC,MAAM,+CAA+C,CAAC;AACvD,OAAO,EAAE,YAAY,EAAE,gBAAgB,EAAE,MAAM,4BAA4B,CAAC;AAC5E,OAAO,EACL,mCAAmC,EACnC,KAAK,0CAA0C,EAC/C,uCAAuC,GACxC,MAAM,mDAAmD,CAAC;AAC3D,OAAO,EACL,UAAU,EACV,oBAAoB,EACpB,KAAK,iBAAiB,EACtB,KAAK,2BAA2B,GACjC,MAAM,gBAAgB,CAAC"} \ No newline at end of file diff --git a/node_modules/@azure/core-rest-pipeline/dist/esm/index.js.map b/node_modules/@azure/core-rest-pipeline/dist/esm/index.js.map index 52b04661..b19f3381 100644 --- a/node_modules/@azure/core-rest-pipeline/dist/esm/index.js.map +++ b/node_modules/@azure/core-rest-pipeline/dist/esm/index.js.map @@ -1 +1 @@ -{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAkClC,OAAO,EAKL,mBAAmB,GACpB,MAAM,eAAe,CAAC;AACvB,OAAO,EACL,yBAAyB,GAI1B,MAAM,gCAAgC,CAAC;AACxC,OAAO,EAAE,uBAAuB,EAAE,MAAM,wBAAwB,CAAC;AACjE,OAAO,EAAE,iBAAiB,EAAE,MAAM,kBAAkB,CAAC;AACrD,OAAO,EAAE,qBAAqB,EAA+B,MAAM,sBAAsB,CAAC;AAC1F,OAAO,EAAE,SAAS,EAAyB,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAC/E,OAAO,EACL,wBAAwB,EACxB,4BAA4B,GAC7B,MAAM,wCAAwC,CAAC;AAChD,OAAO,EACL,sBAAsB,EAEtB,0BAA0B,GAC3B,MAAM,sCAAsC,CAAC;AAC9C,OAAO,EACL,wBAAwB,EACxB,4BAA4B,GAC7B,MAAM,wCAAwC,CAAC;AAChD,OAAO,EAAE,SAAS,EAAE,aAAa,EAAyB,MAAM,yBAAyB,CAAC;AAC1F,OAAO,EAAE,eAAe,EAAE,mBAAmB,EAAE,MAAM,+BAA+B,CAAC;AACrF,OAAO,EAAE,WAAW,EAAE,eAAe,EAAE,uBAAuB,EAAE,MAAM,2BAA2B,CAAC;AAClG,OAAO,EACL,cAAc,EACd,kBAAkB,GAEnB,MAAM,8BAA8B,CAAC;AACtC,OAAO,EACL,sBAAsB,EAEtB,0BAA0B,GAC3B,MAAM,sCAAsC,CAAC;AAC9C,OAAO,EACL,qBAAqB,EACrB,yBAAyB,GAE1B,MAAM,qCAAqC,CAAC;AAC7C,OAAO,EAAE,WAAW,EAA2B,MAAM,2BAA2B,CAAC;AAMjF,OAAO,EACL,aAAa,EACb,iBAAiB,GAElB,MAAM,6BAA6B,CAAC;AACrC,OAAO,EACL,kBAAkB,GAEnB,MAAM,kCAAkC,CAAC;AAC1C,OAAO,EACL,eAAe,EACf,mBAAmB,GAEpB,MAAM,+BAA+B,CAAC;AACvC,OAAO,EAAE,SAAS,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAC;AACnE,OAAO,EAAE,cAAc,EAAE,kBAAkB,EAAE,MAAM,8BAA8B,CAAC;AAClF,OAAO,EACL,+BAA+B,EAE/B,mCAAmC,GAIpC,MAAM,+CAA+C,CAAC;AACvD,OAAO,EAAE,YAAY,EAAE,gBAAgB,EAAE,MAAM,4BAA4B,CAAC;AAC5E,OAAO,EACL,mCAAmC,EAEnC,uCAAuC,GACxC,MAAM,mDAAmD,CAAC;AAC3D,OAAO,EACL,UAAU,EACV,oBAAoB,GAGrB,MAAM,gBAAgB,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\n/* eslint-disable @typescript-eslint/no-unused-vars */\ndeclare global {\n interface FormData {}\n interface Blob {}\n interface File {}\n interface ReadableStream {}\n interface TransformStream {}\n}\n\n/* eslint-enable @typescript-eslint/no-unused-vars */\nexport type { HttpMethods } from \"@azure/core-util\";\nexport type {\n Agent,\n BodyPart,\n FormDataMap,\n FormDataValue,\n HttpClient,\n HttpHeaders,\n KeyObject,\n MultipartRequestBody,\n PipelineRequest,\n PipelineResponse,\n PipelineRetryOptions,\n ProxySettings,\n PxfObject,\n RawHttpHeaders,\n RawHttpHeadersInput,\n RequestBodyType,\n SendRequest,\n TlsSettings,\n TransferProgressEvent,\n} from \"./interfaces.js\";\nexport {\n type AddPolicyOptions as AddPipelineOptions,\n type PipelinePhase,\n type PipelinePolicy,\n type Pipeline,\n createEmptyPipeline,\n} from \"./pipeline.js\";\nexport {\n createPipelineFromOptions,\n type TelemetryOptions,\n type InternalPipelineOptions,\n type PipelineOptions,\n} from \"./createPipelineFromOptions.js\";\nexport { createDefaultHttpClient } from \"./defaultHttpClient.js\";\nexport { createHttpHeaders } from \"./httpHeaders.js\";\nexport { createPipelineRequest, type PipelineRequestOptions } from \"./pipelineRequest.js\";\nexport { RestError, type RestErrorOptions, isRestError } from \"./restError.js\";\nexport {\n decompressResponsePolicy,\n decompressResponsePolicyName,\n} from \"./policies/decompressResponsePolicy.js\";\nexport {\n exponentialRetryPolicy,\n type ExponentialRetryPolicyOptions,\n exponentialRetryPolicyName,\n} from \"./policies/exponentialRetryPolicy.js\";\nexport {\n setClientRequestIdPolicy,\n setClientRequestIdPolicyName,\n} from \"./policies/setClientRequestIdPolicy.js\";\nexport { logPolicy, logPolicyName, type LogPolicyOptions } from \"./policies/logPolicy.js\";\nexport { multipartPolicy, multipartPolicyName } from \"./policies/multipartPolicy.js\";\nexport { proxyPolicy, proxyPolicyName, getDefaultProxySettings } from \"./policies/proxyPolicy.js\";\nexport {\n redirectPolicy,\n redirectPolicyName,\n type RedirectPolicyOptions,\n} from \"./policies/redirectPolicy.js\";\nexport {\n systemErrorRetryPolicy,\n type SystemErrorRetryPolicyOptions,\n systemErrorRetryPolicyName,\n} from \"./policies/systemErrorRetryPolicy.js\";\nexport {\n throttlingRetryPolicy,\n throttlingRetryPolicyName,\n type ThrottlingRetryPolicyOptions,\n} from \"./policies/throttlingRetryPolicy.js\";\nexport { retryPolicy, type RetryPolicyOptions } from \"./policies/retryPolicy.js\";\nexport type {\n RetryStrategy,\n RetryInformation,\n RetryModifiers,\n} from \"./retryStrategies/retryStrategy.js\";\nexport {\n tracingPolicy,\n tracingPolicyName,\n type TracingPolicyOptions,\n} from \"./policies/tracingPolicy.js\";\nexport {\n defaultRetryPolicy,\n type DefaultRetryPolicyOptions,\n} from \"./policies/defaultRetryPolicy.js\";\nexport {\n userAgentPolicy,\n userAgentPolicyName,\n type UserAgentPolicyOptions,\n} from \"./policies/userAgentPolicy.js\";\nexport { tlsPolicy, tlsPolicyName } from \"./policies/tlsPolicy.js\";\nexport { formDataPolicy, formDataPolicyName } from \"./policies/formDataPolicy.js\";\nexport {\n bearerTokenAuthenticationPolicy,\n type BearerTokenAuthenticationPolicyOptions,\n bearerTokenAuthenticationPolicyName,\n type ChallengeCallbacks,\n type AuthorizeRequestOptions,\n type AuthorizeRequestOnChallengeOptions,\n} from \"./policies/bearerTokenAuthenticationPolicy.js\";\nexport { ndJsonPolicy, ndJsonPolicyName } from \"./policies/ndJsonPolicy.js\";\nexport {\n auxiliaryAuthenticationHeaderPolicy,\n type AuxiliaryAuthenticationHeaderPolicyOptions,\n auxiliaryAuthenticationHeaderPolicyName,\n} from \"./policies/auxiliaryAuthenticationHeaderPolicy.js\";\nexport {\n createFile,\n createFileFromStream,\n type CreateFileOptions,\n type CreateFileFromStreamOptions,\n} from \"./util/file.js\";\n"]} \ No newline at end of file +{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAgClC,OAAO,EAKL,mBAAmB,GACpB,MAAM,eAAe,CAAC;AACvB,OAAO,EACL,yBAAyB,GAI1B,MAAM,gCAAgC,CAAC;AACxC,OAAO,EAAE,uBAAuB,EAAE,MAAM,wBAAwB,CAAC;AACjE,OAAO,EAAE,iBAAiB,EAAE,MAAM,kBAAkB,CAAC;AACrD,OAAO,EAAE,qBAAqB,EAA+B,MAAM,sBAAsB,CAAC;AAC1F,OAAO,EAAE,SAAS,EAAyB,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAC/E,OAAO,EACL,wBAAwB,EACxB,4BAA4B,GAC7B,MAAM,wCAAwC,CAAC;AAChD,OAAO,EACL,sBAAsB,EAEtB,0BAA0B,GAC3B,MAAM,sCAAsC,CAAC;AAC9C,OAAO,EACL,wBAAwB,EACxB,4BAA4B,GAC7B,MAAM,wCAAwC,CAAC;AAChD,OAAO,EAAE,SAAS,EAAE,aAAa,EAAyB,MAAM,yBAAyB,CAAC;AAC1F,OAAO,EAAE,eAAe,EAAE,mBAAmB,EAAE,MAAM,+BAA+B,CAAC;AACrF,OAAO,EAAE,WAAW,EAAE,eAAe,EAAE,uBAAuB,EAAE,MAAM,2BAA2B,CAAC;AAClG,OAAO,EACL,cAAc,EACd,kBAAkB,GAEnB,MAAM,8BAA8B,CAAC;AACtC,OAAO,EACL,sBAAsB,EAEtB,0BAA0B,GAC3B,MAAM,sCAAsC,CAAC;AAC9C,OAAO,EACL,qBAAqB,EACrB,yBAAyB,GAE1B,MAAM,qCAAqC,CAAC;AAC7C,OAAO,EAAE,WAAW,EAA2B,MAAM,2BAA2B,CAAC;AAMjF,OAAO,EACL,aAAa,EACb,iBAAiB,GAElB,MAAM,6BAA6B,CAAC;AACrC,OAAO,EACL,kBAAkB,GAEnB,MAAM,kCAAkC,CAAC;AAC1C,OAAO,EACL,eAAe,EACf,mBAAmB,GAEpB,MAAM,+BAA+B,CAAC;AACvC,OAAO,EAAE,SAAS,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAC;AACnE,OAAO,EAAE,cAAc,EAAE,kBAAkB,EAAE,MAAM,8BAA8B,CAAC;AAClF,OAAO,EACL,+BAA+B,EAE/B,mCAAmC,GAIpC,MAAM,+CAA+C,CAAC;AACvD,OAAO,EAAE,YAAY,EAAE,gBAAgB,EAAE,MAAM,4BAA4B,CAAC;AAC5E,OAAO,EACL,mCAAmC,EAEnC,uCAAuC,GACxC,MAAM,mDAAmD,CAAC;AAC3D,OAAO,EACL,UAAU,EACV,oBAAoB,GAGrB,MAAM,gBAAgB,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\ndeclare global {\n interface FormData {}\n interface Blob {}\n interface File {}\n interface ReadableStream {}\n interface TransformStream {}\n}\n\nexport type { HttpMethods } from \"@azure/core-util\";\nexport type {\n Agent,\n BodyPart,\n FormDataMap,\n FormDataValue,\n HttpClient,\n HttpHeaders,\n KeyObject,\n MultipartRequestBody,\n PipelineRequest,\n PipelineResponse,\n PipelineRetryOptions,\n ProxySettings,\n PxfObject,\n RawHttpHeaders,\n RawHttpHeadersInput,\n RequestBodyType,\n SendRequest,\n TlsSettings,\n TransferProgressEvent,\n} from \"./interfaces.js\";\nexport {\n type AddPolicyOptions as AddPipelineOptions,\n type PipelinePhase,\n type PipelinePolicy,\n type Pipeline,\n createEmptyPipeline,\n} from \"./pipeline.js\";\nexport {\n createPipelineFromOptions,\n type TelemetryOptions,\n type InternalPipelineOptions,\n type PipelineOptions,\n} from \"./createPipelineFromOptions.js\";\nexport { createDefaultHttpClient } from \"./defaultHttpClient.js\";\nexport { createHttpHeaders } from \"./httpHeaders.js\";\nexport { createPipelineRequest, type PipelineRequestOptions } from \"./pipelineRequest.js\";\nexport { RestError, type RestErrorOptions, isRestError } from \"./restError.js\";\nexport {\n decompressResponsePolicy,\n decompressResponsePolicyName,\n} from \"./policies/decompressResponsePolicy.js\";\nexport {\n exponentialRetryPolicy,\n type ExponentialRetryPolicyOptions,\n exponentialRetryPolicyName,\n} from \"./policies/exponentialRetryPolicy.js\";\nexport {\n setClientRequestIdPolicy,\n setClientRequestIdPolicyName,\n} from \"./policies/setClientRequestIdPolicy.js\";\nexport { logPolicy, logPolicyName, type LogPolicyOptions } from \"./policies/logPolicy.js\";\nexport { multipartPolicy, multipartPolicyName } from \"./policies/multipartPolicy.js\";\nexport { proxyPolicy, proxyPolicyName, getDefaultProxySettings } from \"./policies/proxyPolicy.js\";\nexport {\n redirectPolicy,\n redirectPolicyName,\n type RedirectPolicyOptions,\n} from \"./policies/redirectPolicy.js\";\nexport {\n systemErrorRetryPolicy,\n type SystemErrorRetryPolicyOptions,\n systemErrorRetryPolicyName,\n} from \"./policies/systemErrorRetryPolicy.js\";\nexport {\n throttlingRetryPolicy,\n throttlingRetryPolicyName,\n type ThrottlingRetryPolicyOptions,\n} from \"./policies/throttlingRetryPolicy.js\";\nexport { retryPolicy, type RetryPolicyOptions } from \"./policies/retryPolicy.js\";\nexport type {\n RetryStrategy,\n RetryInformation,\n RetryModifiers,\n} from \"./retryStrategies/retryStrategy.js\";\nexport {\n tracingPolicy,\n tracingPolicyName,\n type TracingPolicyOptions,\n} from \"./policies/tracingPolicy.js\";\nexport {\n defaultRetryPolicy,\n type DefaultRetryPolicyOptions,\n} from \"./policies/defaultRetryPolicy.js\";\nexport {\n userAgentPolicy,\n userAgentPolicyName,\n type UserAgentPolicyOptions,\n} from \"./policies/userAgentPolicy.js\";\nexport { tlsPolicy, tlsPolicyName } from \"./policies/tlsPolicy.js\";\nexport { formDataPolicy, formDataPolicyName } from \"./policies/formDataPolicy.js\";\nexport {\n bearerTokenAuthenticationPolicy,\n type BearerTokenAuthenticationPolicyOptions,\n bearerTokenAuthenticationPolicyName,\n type ChallengeCallbacks,\n type AuthorizeRequestOptions,\n type AuthorizeRequestOnChallengeOptions,\n} from \"./policies/bearerTokenAuthenticationPolicy.js\";\nexport { ndJsonPolicy, ndJsonPolicyName } from \"./policies/ndJsonPolicy.js\";\nexport {\n auxiliaryAuthenticationHeaderPolicy,\n type AuxiliaryAuthenticationHeaderPolicyOptions,\n auxiliaryAuthenticationHeaderPolicyName,\n} from \"./policies/auxiliaryAuthenticationHeaderPolicy.js\";\nexport {\n createFile,\n createFileFromStream,\n type CreateFileOptions,\n type CreateFileFromStreamOptions,\n} from \"./util/file.js\";\n"]} \ No newline at end of file diff --git a/node_modules/@azure/core-rest-pipeline/dist/esm/policies/retryPolicy.d.ts.map b/node_modules/@azure/core-rest-pipeline/dist/esm/policies/retryPolicy.d.ts.map index d4afad3b..a94ed48e 100644 --- a/node_modules/@azure/core-rest-pipeline/dist/esm/policies/retryPolicy.d.ts.map +++ b/node_modules/@azure/core-rest-pipeline/dist/esm/policies/retryPolicy.d.ts.map @@ -1 +1 @@ -{"version":3,"file":"retryPolicy.d.ts","sourceRoot":"","sources":["../../../src/policies/retryPolicy.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAErD,OAAO,EAAE,KAAK,WAAW,EAAsB,MAAM,eAAe,CAAC;AACrE,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,qCAAqC,CAAC;AAYzE;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,MAAM,CAAC,EAAE,WAAW,CAAC;CACtB;AAED;;GAEG;AACH,wBAAgB,WAAW,CACzB,UAAU,EAAE,aAAa,EAAE,EAC3B,OAAO,GAAE,kBAA+D,GACvE,cAAc,CAmHhB"} \ No newline at end of file +{"version":3,"file":"retryPolicy.d.ts","sourceRoot":"","sources":["../../../src/policies/retryPolicy.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAErD,OAAO,EAAE,KAAK,WAAW,EAAsB,MAAM,eAAe,CAAC;AACrE,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,qCAAqC,CAAC;AAYzE;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,MAAM,CAAC,EAAE,WAAW,CAAC;CACtB;AAED;;GAEG;AACH,wBAAgB,WAAW,CACzB,UAAU,EAAE,aAAa,EAAE,EAC3B,OAAO,GAAE,kBAA+D,GACvE,cAAc,CAkHhB"} \ No newline at end of file diff --git a/node_modules/@azure/core-rest-pipeline/dist/esm/policies/retryPolicy.js b/node_modules/@azure/core-rest-pipeline/dist/esm/policies/retryPolicy.js index 9629aa29..7c16db75 100644 --- a/node_modules/@azure/core-rest-pipeline/dist/esm/policies/retryPolicy.js +++ b/node_modules/@azure/core-rest-pipeline/dist/esm/policies/retryPolicy.js @@ -21,7 +21,6 @@ export function retryPolicy(strategies, options = { maxRetries: DEFAULT_RETRY_PO let response; let responseError; let retryCount = -1; - // eslint-disable-next-line no-constant-condition retryRequest: while (true) { retryCount += 1; response = undefined; diff --git a/node_modules/@azure/core-rest-pipeline/dist/esm/policies/retryPolicy.js.map b/node_modules/@azure/core-rest-pipeline/dist/esm/policies/retryPolicy.js.map index 04b1b73d..51ba69b8 100644 --- a/node_modules/@azure/core-rest-pipeline/dist/esm/policies/retryPolicy.js.map +++ b/node_modules/@azure/core-rest-pipeline/dist/esm/policies/retryPolicy.js.map @@ -1 +1 @@ -{"version":3,"file":"retryPolicy.js","sourceRoot":"","sources":["../../../src/policies/retryPolicy.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAIlC,OAAO,EAAE,KAAK,EAAE,MAAM,oBAAoB,CAAC;AAC3C,OAAO,EAAoB,kBAAkB,EAAE,MAAM,eAAe,CAAC;AAGrE,OAAO,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAC;AACrD,OAAO,EAAE,0BAA0B,EAAE,MAAM,iBAAiB,CAAC;AAE7D,MAAM,iBAAiB,GAAG,kBAAkB,CAAC,gCAAgC,CAAC,CAAC;AAE/E;;GAEG;AACH,MAAM,eAAe,GAAG,aAAa,CAAC;AAgBtC;;GAEG;AACH,MAAM,UAAU,WAAW,CACzB,UAA2B,EAC3B,UAA8B,EAAE,UAAU,EAAE,0BAA0B,EAAE;IAExE,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,IAAI,iBAAiB,CAAC;IACnD,OAAO;QACL,IAAI,EAAE,eAAe;QACrB,KAAK,CAAC,WAAW,CAAC,OAAwB,EAAE,IAAiB;;YAC3D,IAAI,QAAsC,CAAC;YAC3C,IAAI,aAAoC,CAAC;YACzC,IAAI,UAAU,GAAG,CAAC,CAAC,CAAC;YAEpB,iDAAiD;YACjD,YAAY,EAAE,OAAO,IAAI,EAAE,CAAC;gBAC1B,UAAU,IAAI,CAAC,CAAC;gBAChB,QAAQ,GAAG,SAAS,CAAC;gBACrB,aAAa,GAAG,SAAS,CAAC;gBAE1B,IAAI,CAAC;oBACH,MAAM,CAAC,IAAI,CAAC,SAAS,UAAU,8BAA8B,EAAE,OAAO,CAAC,SAAS,CAAC,CAAC;oBAClF,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,CAAC;oBAC/B,MAAM,CAAC,IAAI,CAAC,SAAS,UAAU,oCAAoC,EAAE,OAAO,CAAC,SAAS,CAAC,CAAC;gBAC1F,CAAC;gBAAC,OAAO,CAAM,EAAE,CAAC;oBAChB,MAAM,CAAC,KAAK,CAAC,SAAS,UAAU,kCAAkC,EAAE,OAAO,CAAC,SAAS,CAAC,CAAC;oBAEvF,yDAAyD;oBACzD,gGAAgG;oBAChG,sEAAsE;oBACtE,aAAa,GAAG,CAAc,CAAC;oBAC/B,IAAI,CAAC,CAAC,IAAI,aAAa,CAAC,IAAI,KAAK,WAAW,EAAE,CAAC;wBAC7C,MAAM,CAAC,CAAC;oBACV,CAAC;oBAED,QAAQ,GAAG,aAAa,CAAC,QAAQ,CAAC;gBACpC,CAAC;gBAED,IAAI,MAAA,OAAO,CAAC,WAAW,0CAAE,OAAO,EAAE,CAAC;oBACjC,MAAM,CAAC,KAAK,CAAC,SAAS,UAAU,oBAAoB,CAAC,CAAC;oBACtD,MAAM,UAAU,GAAG,IAAI,UAAU,EAAE,CAAC;oBACpC,MAAM,UAAU,CAAC;gBACnB,CAAC;gBAED,IAAI,UAAU,IAAI,CAAC,MAAA,OAAO,CAAC,UAAU,mCAAI,0BAA0B,CAAC,EAAE,CAAC;oBACrE,MAAM,CAAC,IAAI,CACT,SAAS,UAAU,uGAAuG,CAC3H,CAAC;oBACF,IAAI,aAAa,EAAE,CAAC;wBAClB,MAAM,aAAa,CAAC;oBACtB,CAAC;yBAAM,IAAI,QAAQ,EAAE,CAAC;wBACpB,OAAO,QAAQ,CAAC;oBAClB,CAAC;yBAAM,CAAC;wBACN,MAAM,IAAI,KAAK,CAAC,4DAA4D,CAAC,CAAC;oBAChF,CAAC;gBACH,CAAC;gBAED,MAAM,CAAC,IAAI,CAAC,SAAS,UAAU,gBAAgB,UAAU,CAAC,MAAM,oBAAoB,CAAC,CAAC;gBAEtF,cAAc,EAAE,KAAK,MAAM,QAAQ,IAAI,UAAU,EAAE,CAAC;oBAClD,MAAM,cAAc,GAAG,QAAQ,CAAC,MAAM,IAAI,iBAAiB,CAAC;oBAC5D,cAAc,CAAC,IAAI,CAAC,SAAS,UAAU,+BAA+B,QAAQ,CAAC,IAAI,GAAG,CAAC,CAAC;oBAExF,MAAM,SAAS,GAAG,QAAQ,CAAC,KAAK,CAAC;wBAC/B,UAAU;wBACV,QAAQ;wBACR,aAAa;qBACd,CAAC,CAAC;oBAEH,IAAI,SAAS,CAAC,YAAY,EAAE,CAAC;wBAC3B,cAAc,CAAC,IAAI,CAAC,SAAS,UAAU,YAAY,CAAC,CAAC;wBACrD,SAAS,cAAc,CAAC;oBAC1B,CAAC;oBAED,MAAM,EAAE,YAAY,EAAE,cAAc,EAAE,UAAU,EAAE,GAAG,SAAS,CAAC;oBAE/D,IAAI,YAAY,EAAE,CAAC;wBACjB,cAAc,CAAC,KAAK,CAClB,SAAS,UAAU,oBAAoB,QAAQ,CAAC,IAAI,gBAAgB,EACpE,YAAY,CACb,CAAC;wBACF,MAAM,YAAY,CAAC;oBACrB,CAAC;oBAED,IAAI,cAAc,IAAI,cAAc,KAAK,CAAC,EAAE,CAAC;wBAC3C,cAAc,CAAC,IAAI,CACjB,SAAS,UAAU,oBAAoB,QAAQ,CAAC,IAAI,kBAAkB,cAAc,EAAE,CACvF,CAAC;wBACF,MAAM,KAAK,CAAC,cAAc,EAAE,SAAS,EAAE,EAAE,WAAW,EAAE,OAAO,CAAC,WAAW,EAAE,CAAC,CAAC;wBAC7E,SAAS,YAAY,CAAC;oBACxB,CAAC;oBAED,IAAI,UAAU,EAAE,CAAC;wBACf,cAAc,CAAC,IAAI,CACjB,SAAS,UAAU,oBAAoB,QAAQ,CAAC,IAAI,iBAAiB,UAAU,EAAE,CAClF,CAAC;wBACF,OAAO,CAAC,GAAG,GAAG,UAAU,CAAC;wBACzB,SAAS,YAAY,CAAC;oBACxB,CAAC;gBACH,CAAC;gBAED,IAAI,aAAa,EAAE,CAAC;oBAClB,MAAM,CAAC,IAAI,CACT,+EAA+E,CAChF,CAAC;oBACF,MAAM,aAAa,CAAC;gBACtB,CAAC;gBACD,IAAI,QAAQ,EAAE,CAAC;oBACb,MAAM,CAAC,IAAI,CACT,mFAAmF,CACpF,CAAC;oBACF,OAAO,QAAQ,CAAC;gBAClB,CAAC;gBAED,mDAAmD;gBACnD,+DAA+D;gBAC/D,iCAAiC;YACnC,CAAC;QACH,CAAC;KACF,CAAC;AACJ,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport type { PipelineRequest, PipelineResponse, SendRequest } from \"../interfaces.js\";\nimport type { PipelinePolicy } from \"../pipeline.js\";\nimport { delay } from \"../util/helpers.js\";\nimport { type AzureLogger, createClientLogger } from \"@azure/logger\";\nimport type { RetryStrategy } from \"../retryStrategies/retryStrategy.js\";\nimport type { RestError } from \"../restError.js\";\nimport { AbortError } from \"@azure/abort-controller\";\nimport { DEFAULT_RETRY_POLICY_COUNT } from \"../constants.js\";\n\nconst retryPolicyLogger = createClientLogger(\"core-rest-pipeline retryPolicy\");\n\n/**\n * The programmatic identifier of the retryPolicy.\n */\nconst retryPolicyName = \"retryPolicy\";\n\n/**\n * Options to the {@link retryPolicy}\n */\nexport interface RetryPolicyOptions {\n /**\n * Maximum number of retries. If not specified, it will limit to 3 retries.\n */\n maxRetries?: number;\n /**\n * Logger. If it's not provided, a default logger is used.\n */\n logger?: AzureLogger;\n}\n\n/**\n * retryPolicy is a generic policy to enable retrying requests when certain conditions are met\n */\nexport function retryPolicy(\n strategies: RetryStrategy[],\n options: RetryPolicyOptions = { maxRetries: DEFAULT_RETRY_POLICY_COUNT },\n): PipelinePolicy {\n const logger = options.logger || retryPolicyLogger;\n return {\n name: retryPolicyName,\n async sendRequest(request: PipelineRequest, next: SendRequest): Promise {\n let response: PipelineResponse | undefined;\n let responseError: RestError | undefined;\n let retryCount = -1;\n\n // eslint-disable-next-line no-constant-condition\n retryRequest: while (true) {\n retryCount += 1;\n response = undefined;\n responseError = undefined;\n\n try {\n logger.info(`Retry ${retryCount}: Attempting to send request`, request.requestId);\n response = await next(request);\n logger.info(`Retry ${retryCount}: Received a response from request`, request.requestId);\n } catch (e: any) {\n logger.error(`Retry ${retryCount}: Received an error from request`, request.requestId);\n\n // RestErrors are valid targets for the retry strategies.\n // If none of the retry strategies can work with them, they will be thrown later in this policy.\n // If the received error is not a RestError, it is immediately thrown.\n responseError = e as RestError;\n if (!e || responseError.name !== \"RestError\") {\n throw e;\n }\n\n response = responseError.response;\n }\n\n if (request.abortSignal?.aborted) {\n logger.error(`Retry ${retryCount}: Request aborted.`);\n const abortError = new AbortError();\n throw abortError;\n }\n\n if (retryCount >= (options.maxRetries ?? DEFAULT_RETRY_POLICY_COUNT)) {\n logger.info(\n `Retry ${retryCount}: Maximum retries reached. Returning the last received response, or throwing the last received error.`,\n );\n if (responseError) {\n throw responseError;\n } else if (response) {\n return response;\n } else {\n throw new Error(\"Maximum retries reached with no response or error to throw\");\n }\n }\n\n logger.info(`Retry ${retryCount}: Processing ${strategies.length} retry strategies.`);\n\n strategiesLoop: for (const strategy of strategies) {\n const strategyLogger = strategy.logger || retryPolicyLogger;\n strategyLogger.info(`Retry ${retryCount}: Processing retry strategy ${strategy.name}.`);\n\n const modifiers = strategy.retry({\n retryCount,\n response,\n responseError,\n });\n\n if (modifiers.skipStrategy) {\n strategyLogger.info(`Retry ${retryCount}: Skipped.`);\n continue strategiesLoop;\n }\n\n const { errorToThrow, retryAfterInMs, redirectTo } = modifiers;\n\n if (errorToThrow) {\n strategyLogger.error(\n `Retry ${retryCount}: Retry strategy ${strategy.name} throws error:`,\n errorToThrow,\n );\n throw errorToThrow;\n }\n\n if (retryAfterInMs || retryAfterInMs === 0) {\n strategyLogger.info(\n `Retry ${retryCount}: Retry strategy ${strategy.name} retries after ${retryAfterInMs}`,\n );\n await delay(retryAfterInMs, undefined, { abortSignal: request.abortSignal });\n continue retryRequest;\n }\n\n if (redirectTo) {\n strategyLogger.info(\n `Retry ${retryCount}: Retry strategy ${strategy.name} redirects to ${redirectTo}`,\n );\n request.url = redirectTo;\n continue retryRequest;\n }\n }\n\n if (responseError) {\n logger.info(\n `None of the retry strategies could work with the received error. Throwing it.`,\n );\n throw responseError;\n }\n if (response) {\n logger.info(\n `None of the retry strategies could work with the received response. Returning it.`,\n );\n return response;\n }\n\n // If all the retries skip and there's no response,\n // we're still in the retry loop, so a new request will be sent\n // until `maxRetries` is reached.\n }\n },\n };\n}\n"]} \ No newline at end of file +{"version":3,"file":"retryPolicy.js","sourceRoot":"","sources":["../../../src/policies/retryPolicy.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAIlC,OAAO,EAAE,KAAK,EAAE,MAAM,oBAAoB,CAAC;AAC3C,OAAO,EAAoB,kBAAkB,EAAE,MAAM,eAAe,CAAC;AAGrE,OAAO,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAC;AACrD,OAAO,EAAE,0BAA0B,EAAE,MAAM,iBAAiB,CAAC;AAE7D,MAAM,iBAAiB,GAAG,kBAAkB,CAAC,gCAAgC,CAAC,CAAC;AAE/E;;GAEG;AACH,MAAM,eAAe,GAAG,aAAa,CAAC;AAgBtC;;GAEG;AACH,MAAM,UAAU,WAAW,CACzB,UAA2B,EAC3B,UAA8B,EAAE,UAAU,EAAE,0BAA0B,EAAE;IAExE,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,IAAI,iBAAiB,CAAC;IACnD,OAAO;QACL,IAAI,EAAE,eAAe;QACrB,KAAK,CAAC,WAAW,CAAC,OAAwB,EAAE,IAAiB;;YAC3D,IAAI,QAAsC,CAAC;YAC3C,IAAI,aAAoC,CAAC;YACzC,IAAI,UAAU,GAAG,CAAC,CAAC,CAAC;YAEpB,YAAY,EAAE,OAAO,IAAI,EAAE,CAAC;gBAC1B,UAAU,IAAI,CAAC,CAAC;gBAChB,QAAQ,GAAG,SAAS,CAAC;gBACrB,aAAa,GAAG,SAAS,CAAC;gBAE1B,IAAI,CAAC;oBACH,MAAM,CAAC,IAAI,CAAC,SAAS,UAAU,8BAA8B,EAAE,OAAO,CAAC,SAAS,CAAC,CAAC;oBAClF,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,CAAC;oBAC/B,MAAM,CAAC,IAAI,CAAC,SAAS,UAAU,oCAAoC,EAAE,OAAO,CAAC,SAAS,CAAC,CAAC;gBAC1F,CAAC;gBAAC,OAAO,CAAM,EAAE,CAAC;oBAChB,MAAM,CAAC,KAAK,CAAC,SAAS,UAAU,kCAAkC,EAAE,OAAO,CAAC,SAAS,CAAC,CAAC;oBAEvF,yDAAyD;oBACzD,gGAAgG;oBAChG,sEAAsE;oBACtE,aAAa,GAAG,CAAc,CAAC;oBAC/B,IAAI,CAAC,CAAC,IAAI,aAAa,CAAC,IAAI,KAAK,WAAW,EAAE,CAAC;wBAC7C,MAAM,CAAC,CAAC;oBACV,CAAC;oBAED,QAAQ,GAAG,aAAa,CAAC,QAAQ,CAAC;gBACpC,CAAC;gBAED,IAAI,MAAA,OAAO,CAAC,WAAW,0CAAE,OAAO,EAAE,CAAC;oBACjC,MAAM,CAAC,KAAK,CAAC,SAAS,UAAU,oBAAoB,CAAC,CAAC;oBACtD,MAAM,UAAU,GAAG,IAAI,UAAU,EAAE,CAAC;oBACpC,MAAM,UAAU,CAAC;gBACnB,CAAC;gBAED,IAAI,UAAU,IAAI,CAAC,MAAA,OAAO,CAAC,UAAU,mCAAI,0BAA0B,CAAC,EAAE,CAAC;oBACrE,MAAM,CAAC,IAAI,CACT,SAAS,UAAU,uGAAuG,CAC3H,CAAC;oBACF,IAAI,aAAa,EAAE,CAAC;wBAClB,MAAM,aAAa,CAAC;oBACtB,CAAC;yBAAM,IAAI,QAAQ,EAAE,CAAC;wBACpB,OAAO,QAAQ,CAAC;oBAClB,CAAC;yBAAM,CAAC;wBACN,MAAM,IAAI,KAAK,CAAC,4DAA4D,CAAC,CAAC;oBAChF,CAAC;gBACH,CAAC;gBAED,MAAM,CAAC,IAAI,CAAC,SAAS,UAAU,gBAAgB,UAAU,CAAC,MAAM,oBAAoB,CAAC,CAAC;gBAEtF,cAAc,EAAE,KAAK,MAAM,QAAQ,IAAI,UAAU,EAAE,CAAC;oBAClD,MAAM,cAAc,GAAG,QAAQ,CAAC,MAAM,IAAI,iBAAiB,CAAC;oBAC5D,cAAc,CAAC,IAAI,CAAC,SAAS,UAAU,+BAA+B,QAAQ,CAAC,IAAI,GAAG,CAAC,CAAC;oBAExF,MAAM,SAAS,GAAG,QAAQ,CAAC,KAAK,CAAC;wBAC/B,UAAU;wBACV,QAAQ;wBACR,aAAa;qBACd,CAAC,CAAC;oBAEH,IAAI,SAAS,CAAC,YAAY,EAAE,CAAC;wBAC3B,cAAc,CAAC,IAAI,CAAC,SAAS,UAAU,YAAY,CAAC,CAAC;wBACrD,SAAS,cAAc,CAAC;oBAC1B,CAAC;oBAED,MAAM,EAAE,YAAY,EAAE,cAAc,EAAE,UAAU,EAAE,GAAG,SAAS,CAAC;oBAE/D,IAAI,YAAY,EAAE,CAAC;wBACjB,cAAc,CAAC,KAAK,CAClB,SAAS,UAAU,oBAAoB,QAAQ,CAAC,IAAI,gBAAgB,EACpE,YAAY,CACb,CAAC;wBACF,MAAM,YAAY,CAAC;oBACrB,CAAC;oBAED,IAAI,cAAc,IAAI,cAAc,KAAK,CAAC,EAAE,CAAC;wBAC3C,cAAc,CAAC,IAAI,CACjB,SAAS,UAAU,oBAAoB,QAAQ,CAAC,IAAI,kBAAkB,cAAc,EAAE,CACvF,CAAC;wBACF,MAAM,KAAK,CAAC,cAAc,EAAE,SAAS,EAAE,EAAE,WAAW,EAAE,OAAO,CAAC,WAAW,EAAE,CAAC,CAAC;wBAC7E,SAAS,YAAY,CAAC;oBACxB,CAAC;oBAED,IAAI,UAAU,EAAE,CAAC;wBACf,cAAc,CAAC,IAAI,CACjB,SAAS,UAAU,oBAAoB,QAAQ,CAAC,IAAI,iBAAiB,UAAU,EAAE,CAClF,CAAC;wBACF,OAAO,CAAC,GAAG,GAAG,UAAU,CAAC;wBACzB,SAAS,YAAY,CAAC;oBACxB,CAAC;gBACH,CAAC;gBAED,IAAI,aAAa,EAAE,CAAC;oBAClB,MAAM,CAAC,IAAI,CACT,+EAA+E,CAChF,CAAC;oBACF,MAAM,aAAa,CAAC;gBACtB,CAAC;gBACD,IAAI,QAAQ,EAAE,CAAC;oBACb,MAAM,CAAC,IAAI,CACT,mFAAmF,CACpF,CAAC;oBACF,OAAO,QAAQ,CAAC;gBAClB,CAAC;gBAED,mDAAmD;gBACnD,+DAA+D;gBAC/D,iCAAiC;YACnC,CAAC;QACH,CAAC;KACF,CAAC;AACJ,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport type { PipelineRequest, PipelineResponse, SendRequest } from \"../interfaces.js\";\nimport type { PipelinePolicy } from \"../pipeline.js\";\nimport { delay } from \"../util/helpers.js\";\nimport { type AzureLogger, createClientLogger } from \"@azure/logger\";\nimport type { RetryStrategy } from \"../retryStrategies/retryStrategy.js\";\nimport type { RestError } from \"../restError.js\";\nimport { AbortError } from \"@azure/abort-controller\";\nimport { DEFAULT_RETRY_POLICY_COUNT } from \"../constants.js\";\n\nconst retryPolicyLogger = createClientLogger(\"core-rest-pipeline retryPolicy\");\n\n/**\n * The programmatic identifier of the retryPolicy.\n */\nconst retryPolicyName = \"retryPolicy\";\n\n/**\n * Options to the {@link retryPolicy}\n */\nexport interface RetryPolicyOptions {\n /**\n * Maximum number of retries. If not specified, it will limit to 3 retries.\n */\n maxRetries?: number;\n /**\n * Logger. If it's not provided, a default logger is used.\n */\n logger?: AzureLogger;\n}\n\n/**\n * retryPolicy is a generic policy to enable retrying requests when certain conditions are met\n */\nexport function retryPolicy(\n strategies: RetryStrategy[],\n options: RetryPolicyOptions = { maxRetries: DEFAULT_RETRY_POLICY_COUNT },\n): PipelinePolicy {\n const logger = options.logger || retryPolicyLogger;\n return {\n name: retryPolicyName,\n async sendRequest(request: PipelineRequest, next: SendRequest): Promise {\n let response: PipelineResponse | undefined;\n let responseError: RestError | undefined;\n let retryCount = -1;\n\n retryRequest: while (true) {\n retryCount += 1;\n response = undefined;\n responseError = undefined;\n\n try {\n logger.info(`Retry ${retryCount}: Attempting to send request`, request.requestId);\n response = await next(request);\n logger.info(`Retry ${retryCount}: Received a response from request`, request.requestId);\n } catch (e: any) {\n logger.error(`Retry ${retryCount}: Received an error from request`, request.requestId);\n\n // RestErrors are valid targets for the retry strategies.\n // If none of the retry strategies can work with them, they will be thrown later in this policy.\n // If the received error is not a RestError, it is immediately thrown.\n responseError = e as RestError;\n if (!e || responseError.name !== \"RestError\") {\n throw e;\n }\n\n response = responseError.response;\n }\n\n if (request.abortSignal?.aborted) {\n logger.error(`Retry ${retryCount}: Request aborted.`);\n const abortError = new AbortError();\n throw abortError;\n }\n\n if (retryCount >= (options.maxRetries ?? DEFAULT_RETRY_POLICY_COUNT)) {\n logger.info(\n `Retry ${retryCount}: Maximum retries reached. Returning the last received response, or throwing the last received error.`,\n );\n if (responseError) {\n throw responseError;\n } else if (response) {\n return response;\n } else {\n throw new Error(\"Maximum retries reached with no response or error to throw\");\n }\n }\n\n logger.info(`Retry ${retryCount}: Processing ${strategies.length} retry strategies.`);\n\n strategiesLoop: for (const strategy of strategies) {\n const strategyLogger = strategy.logger || retryPolicyLogger;\n strategyLogger.info(`Retry ${retryCount}: Processing retry strategy ${strategy.name}.`);\n\n const modifiers = strategy.retry({\n retryCount,\n response,\n responseError,\n });\n\n if (modifiers.skipStrategy) {\n strategyLogger.info(`Retry ${retryCount}: Skipped.`);\n continue strategiesLoop;\n }\n\n const { errorToThrow, retryAfterInMs, redirectTo } = modifiers;\n\n if (errorToThrow) {\n strategyLogger.error(\n `Retry ${retryCount}: Retry strategy ${strategy.name} throws error:`,\n errorToThrow,\n );\n throw errorToThrow;\n }\n\n if (retryAfterInMs || retryAfterInMs === 0) {\n strategyLogger.info(\n `Retry ${retryCount}: Retry strategy ${strategy.name} retries after ${retryAfterInMs}`,\n );\n await delay(retryAfterInMs, undefined, { abortSignal: request.abortSignal });\n continue retryRequest;\n }\n\n if (redirectTo) {\n strategyLogger.info(\n `Retry ${retryCount}: Retry strategy ${strategy.name} redirects to ${redirectTo}`,\n );\n request.url = redirectTo;\n continue retryRequest;\n }\n }\n\n if (responseError) {\n logger.info(\n `None of the retry strategies could work with the received error. Throwing it.`,\n );\n throw responseError;\n }\n if (response) {\n logger.info(\n `None of the retry strategies could work with the received response. Returning it.`,\n );\n return response;\n }\n\n // If all the retries skip and there's no response,\n // we're still in the retry loop, so a new request will be sent\n // until `maxRetries` is reached.\n }\n },\n };\n}\n"]} \ No newline at end of file diff --git a/node_modules/@azure/core-rest-pipeline/dist/esm/policies/tracingPolicy.js b/node_modules/@azure/core-rest-pipeline/dist/esm/policies/tracingPolicy.js index 1be17ec3..455c2561 100644 --- a/node_modules/@azure/core-rest-pipeline/dist/esm/policies/tracingPolicy.js +++ b/node_modules/@azure/core-rest-pipeline/dist/esm/policies/tracingPolicy.js @@ -115,9 +115,14 @@ function tryProcessResponse(span, response) { if (serviceRequestId) { span.setAttribute("serviceRequestId", serviceRequestId); } - span.setStatus({ - status: "success", - }); + // Per semantic conventions, only set the status to error if the status code is 4xx or 5xx. + // Otherwise, the status MUST remain unset. + // https://opentelemetry.io/docs/specs/semconv/http/http-spans/#status + if (response.status >= 400) { + span.setStatus({ + status: "error", + }); + } span.end(); } catch (e) { diff --git a/node_modules/@azure/core-rest-pipeline/dist/esm/policies/tracingPolicy.js.map b/node_modules/@azure/core-rest-pipeline/dist/esm/policies/tracingPolicy.js.map index e60e964c..b0ced4d4 100644 --- a/node_modules/@azure/core-rest-pipeline/dist/esm/policies/tracingPolicy.js.map +++ b/node_modules/@azure/core-rest-pipeline/dist/esm/policies/tracingPolicy.js.map @@ -1 +1 @@ -{"version":3,"file":"tracingPolicy.js","sourceRoot":"","sources":["../../../src/policies/tracingPolicy.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAElC,OAAO,EAIL,mBAAmB,GACpB,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AAG9C,OAAO,EAAE,iBAAiB,EAAE,MAAM,sBAAsB,CAAC;AACzD,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAC;AACnC,OAAO,EAAE,eAAe,EAAE,OAAO,EAAE,MAAM,kBAAkB,CAAC;AAC5D,OAAO,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AAC9C,OAAO,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAC;AAEjD;;GAEG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,eAAe,CAAC;AAmBjD;;;;;GAKG;AACH,MAAM,UAAU,aAAa,CAAC,UAAgC,EAAE;IAC9D,MAAM,gBAAgB,GAAG,iBAAiB,CAAC,OAAO,CAAC,eAAe,CAAC,CAAC;IACpE,MAAM,SAAS,GAAG,IAAI,SAAS,CAAC;QAC9B,gCAAgC,EAAE,OAAO,CAAC,gCAAgC;KAC3E,CAAC,CAAC;IACH,MAAM,aAAa,GAAG,sBAAsB,EAAE,CAAC;IAE/C,OAAO;QACL,IAAI,EAAE,iBAAiB;QACvB,KAAK,CAAC,WAAW,CAAC,OAAwB,EAAE,IAAiB;;YAC3D,IAAI,CAAC,aAAa,EAAE,CAAC;gBACnB,OAAO,IAAI,CAAC,OAAO,CAAC,CAAC;YACvB,CAAC;YAED,MAAM,SAAS,GAAG,MAAM,gBAAgB,CAAC;YAEzC,MAAM,cAAc,GAAG;gBACrB,UAAU,EAAE,SAAS,CAAC,WAAW,CAAC,OAAO,CAAC,GAAG,CAAC;gBAC9C,aAAa,EAAE,OAAO,CAAC,MAAM;gBAC7B,iBAAiB,EAAE,SAAS;gBAC5B,SAAS,EAAE,OAAO,CAAC,SAAS;aAC7B,CAAC;YACF,IAAI,SAAS,EAAE,CAAC;gBACd,cAAc,CAAC,iBAAiB,CAAC,GAAG,SAAS,CAAC;YAChD,CAAC;YAED,MAAM,EAAE,IAAI,EAAE,cAAc,EAAE,GAAG,MAAA,aAAa,CAAC,aAAa,EAAE,OAAO,EAAE,cAAc,CAAC,mCAAI,EAAE,CAAC;YAE7F,IAAI,CAAC,IAAI,IAAI,CAAC,cAAc,EAAE,CAAC;gBAC7B,OAAO,IAAI,CAAC,OAAO,CAAC,CAAC;YACvB,CAAC;YAED,IAAI,CAAC;gBACH,MAAM,QAAQ,GAAG,MAAM,aAAa,CAAC,WAAW,CAAC,cAAc,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;gBAChF,kBAAkB,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;gBACnC,OAAO,QAAQ,CAAC;YAClB,CAAC;YAAC,OAAO,GAAQ,EAAE,CAAC;gBAClB,eAAe,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;gBAC3B,MAAM,GAAG,CAAC;YACZ,CAAC;QACH,CAAC;KACF,CAAC;AACJ,CAAC;AAED,SAAS,sBAAsB;IAC7B,IAAI,CAAC;QACH,OAAO,mBAAmB,CAAC;YACzB,SAAS,EAAE,EAAE;YACb,WAAW,EAAE,2BAA2B;YACxC,cAAc,EAAE,WAAW;SAC5B,CAAC,CAAC;IACL,CAAC;IAAC,OAAO,CAAU,EAAE,CAAC;QACpB,MAAM,CAAC,OAAO,CAAC,0CAA0C,eAAe,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;QAC/E,OAAO,SAAS,CAAC;IACnB,CAAC;AACH,CAAC;AAED,SAAS,aAAa,CACpB,aAA4B,EAC5B,OAAwB,EACxB,cAAuC;IAEvC,IAAI,CAAC;QACH,oFAAoF;QACpF,MAAM,EAAE,IAAI,EAAE,cAAc,EAAE,GAAG,aAAa,CAAC,SAAS,CACtD,QAAQ,OAAO,CAAC,MAAM,EAAE,EACxB,EAAE,cAAc,EAAE,OAAO,CAAC,cAAc,EAAE,EAC1C;YACE,QAAQ,EAAE,QAAQ;YAClB,cAAc;SACf,CACF,CAAC;QAEF,wDAAwD;QACxD,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,EAAE,CAAC;YACxB,IAAI,CAAC,GAAG,EAAE,CAAC;YACX,OAAO,SAAS,CAAC;QACnB,CAAC;QAED,cAAc;QACd,MAAM,OAAO,GAAG,aAAa,CAAC,oBAAoB,CAChD,cAAc,CAAC,cAAc,CAAC,cAAc,CAC7C,CAAC;QACF,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC;YACnD,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;QAClC,CAAC;QACD,OAAO,EAAE,IAAI,EAAE,cAAc,EAAE,cAAc,CAAC,cAAc,CAAC,cAAc,EAAE,CAAC;IAChF,CAAC;IAAC,OAAO,CAAM,EAAE,CAAC;QAChB,MAAM,CAAC,OAAO,CAAC,qDAAqD,eAAe,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;QAC1F,OAAO,SAAS,CAAC;IACnB,CAAC;AACH,CAAC;AAED,SAAS,eAAe,CAAC,IAAiB,EAAE,KAAc;IACxD,IAAI,CAAC;QACH,IAAI,CAAC,SAAS,CAAC;YACb,MAAM,EAAE,OAAO;YACf,KAAK,EAAE,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS;SAC1C,CAAC,CAAC;QACH,IAAI,WAAW,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,UAAU,EAAE,CAAC;YAC3C,IAAI,CAAC,YAAY,CAAC,kBAAkB,EAAE,KAAK,CAAC,UAAU,CAAC,CAAC;QAC1D,CAAC;QACD,IAAI,CAAC,GAAG,EAAE,CAAC;IACb,CAAC;IAAC,OAAO,CAAM,EAAE,CAAC;QAChB,MAAM,CAAC,OAAO,CAAC,qDAAqD,eAAe,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;IAC5F,CAAC;AACH,CAAC;AAED,SAAS,kBAAkB,CAAC,IAAiB,EAAE,QAA0B;IACvE,IAAI,CAAC;QACH,IAAI,CAAC,YAAY,CAAC,kBAAkB,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAC;QACvD,MAAM,gBAAgB,GAAG,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,iBAAiB,CAAC,CAAC;QACjE,IAAI,gBAAgB,EAAE,CAAC;YACrB,IAAI,CAAC,YAAY,CAAC,kBAAkB,EAAE,gBAAgB,CAAC,CAAC;QAC1D,CAAC;QACD,IAAI,CAAC,SAAS,CAAC;YACb,MAAM,EAAE,SAAS;SAClB,CAAC,CAAC;QACH,IAAI,CAAC,GAAG,EAAE,CAAC;IACb,CAAC;IAAC,OAAO,CAAM,EAAE,CAAC;QAChB,MAAM,CAAC,OAAO,CAAC,qDAAqD,eAAe,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;IAC5F,CAAC;AACH,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport {\n type TracingClient,\n type TracingContext,\n type TracingSpan,\n createTracingClient,\n} from \"@azure/core-tracing\";\nimport { SDK_VERSION } from \"../constants.js\";\nimport type { PipelineRequest, PipelineResponse, SendRequest } from \"../interfaces.js\";\nimport type { PipelinePolicy } from \"../pipeline.js\";\nimport { getUserAgentValue } from \"../util/userAgent.js\";\nimport { logger } from \"../log.js\";\nimport { getErrorMessage, isError } from \"@azure/core-util\";\nimport { isRestError } from \"../restError.js\";\nimport { Sanitizer } from \"../util/sanitizer.js\";\n\n/**\n * The programmatic identifier of the tracingPolicy.\n */\nexport const tracingPolicyName = \"tracingPolicy\";\n\n/**\n * Options to configure the tracing policy.\n */\nexport interface TracingPolicyOptions {\n /**\n * String prefix to add to the user agent logged as metadata\n * on the generated Span.\n * Defaults to an empty string.\n */\n userAgentPrefix?: string;\n /**\n * Query string names whose values will be logged when logging is enabled. By default no\n * query string values are logged.\n */\n additionalAllowedQueryParameters?: string[];\n}\n\n/**\n * A simple policy to create OpenTelemetry Spans for each request made by the pipeline\n * that has SpanOptions with a parent.\n * Requests made without a parent Span will not be recorded.\n * @param options - Options to configure the telemetry logged by the tracing policy.\n */\nexport function tracingPolicy(options: TracingPolicyOptions = {}): PipelinePolicy {\n const userAgentPromise = getUserAgentValue(options.userAgentPrefix);\n const sanitizer = new Sanitizer({\n additionalAllowedQueryParameters: options.additionalAllowedQueryParameters,\n });\n const tracingClient = tryCreateTracingClient();\n\n return {\n name: tracingPolicyName,\n async sendRequest(request: PipelineRequest, next: SendRequest): Promise {\n if (!tracingClient) {\n return next(request);\n }\n\n const userAgent = await userAgentPromise;\n\n const spanAttributes = {\n \"http.url\": sanitizer.sanitizeUrl(request.url),\n \"http.method\": request.method,\n \"http.user_agent\": userAgent,\n requestId: request.requestId,\n };\n if (userAgent) {\n spanAttributes[\"http.user_agent\"] = userAgent;\n }\n\n const { span, tracingContext } = tryCreateSpan(tracingClient, request, spanAttributes) ?? {};\n\n if (!span || !tracingContext) {\n return next(request);\n }\n\n try {\n const response = await tracingClient.withContext(tracingContext, next, request);\n tryProcessResponse(span, response);\n return response;\n } catch (err: any) {\n tryProcessError(span, err);\n throw err;\n }\n },\n };\n}\n\nfunction tryCreateTracingClient(): TracingClient | undefined {\n try {\n return createTracingClient({\n namespace: \"\",\n packageName: \"@azure/core-rest-pipeline\",\n packageVersion: SDK_VERSION,\n });\n } catch (e: unknown) {\n logger.warning(`Error when creating the TracingClient: ${getErrorMessage(e)}`);\n return undefined;\n }\n}\n\nfunction tryCreateSpan(\n tracingClient: TracingClient,\n request: PipelineRequest,\n spanAttributes: Record,\n): { span: TracingSpan; tracingContext: TracingContext } | undefined {\n try {\n // As per spec, we do not need to differentiate between HTTP and HTTPS in span name.\n const { span, updatedOptions } = tracingClient.startSpan(\n `HTTP ${request.method}`,\n { tracingOptions: request.tracingOptions },\n {\n spanKind: \"client\",\n spanAttributes,\n },\n );\n\n // If the span is not recording, don't do any more work.\n if (!span.isRecording()) {\n span.end();\n return undefined;\n }\n\n // set headers\n const headers = tracingClient.createRequestHeaders(\n updatedOptions.tracingOptions.tracingContext,\n );\n for (const [key, value] of Object.entries(headers)) {\n request.headers.set(key, value);\n }\n return { span, tracingContext: updatedOptions.tracingOptions.tracingContext };\n } catch (e: any) {\n logger.warning(`Skipping creating a tracing span due to an error: ${getErrorMessage(e)}`);\n return undefined;\n }\n}\n\nfunction tryProcessError(span: TracingSpan, error: unknown): void {\n try {\n span.setStatus({\n status: \"error\",\n error: isError(error) ? error : undefined,\n });\n if (isRestError(error) && error.statusCode) {\n span.setAttribute(\"http.status_code\", error.statusCode);\n }\n span.end();\n } catch (e: any) {\n logger.warning(`Skipping tracing span processing due to an error: ${getErrorMessage(e)}`);\n }\n}\n\nfunction tryProcessResponse(span: TracingSpan, response: PipelineResponse): void {\n try {\n span.setAttribute(\"http.status_code\", response.status);\n const serviceRequestId = response.headers.get(\"x-ms-request-id\");\n if (serviceRequestId) {\n span.setAttribute(\"serviceRequestId\", serviceRequestId);\n }\n span.setStatus({\n status: \"success\",\n });\n span.end();\n } catch (e: any) {\n logger.warning(`Skipping tracing span processing due to an error: ${getErrorMessage(e)}`);\n }\n}\n"]} \ No newline at end of file +{"version":3,"file":"tracingPolicy.js","sourceRoot":"","sources":["../../../src/policies/tracingPolicy.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAElC,OAAO,EAIL,mBAAmB,GACpB,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AAG9C,OAAO,EAAE,iBAAiB,EAAE,MAAM,sBAAsB,CAAC;AACzD,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAC;AACnC,OAAO,EAAE,eAAe,EAAE,OAAO,EAAE,MAAM,kBAAkB,CAAC;AAC5D,OAAO,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AAC9C,OAAO,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAC;AAEjD;;GAEG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,eAAe,CAAC;AAmBjD;;;;;GAKG;AACH,MAAM,UAAU,aAAa,CAAC,UAAgC,EAAE;IAC9D,MAAM,gBAAgB,GAAG,iBAAiB,CAAC,OAAO,CAAC,eAAe,CAAC,CAAC;IACpE,MAAM,SAAS,GAAG,IAAI,SAAS,CAAC;QAC9B,gCAAgC,EAAE,OAAO,CAAC,gCAAgC;KAC3E,CAAC,CAAC;IACH,MAAM,aAAa,GAAG,sBAAsB,EAAE,CAAC;IAE/C,OAAO;QACL,IAAI,EAAE,iBAAiB;QACvB,KAAK,CAAC,WAAW,CAAC,OAAwB,EAAE,IAAiB;;YAC3D,IAAI,CAAC,aAAa,EAAE,CAAC;gBACnB,OAAO,IAAI,CAAC,OAAO,CAAC,CAAC;YACvB,CAAC;YAED,MAAM,SAAS,GAAG,MAAM,gBAAgB,CAAC;YAEzC,MAAM,cAAc,GAAG;gBACrB,UAAU,EAAE,SAAS,CAAC,WAAW,CAAC,OAAO,CAAC,GAAG,CAAC;gBAC9C,aAAa,EAAE,OAAO,CAAC,MAAM;gBAC7B,iBAAiB,EAAE,SAAS;gBAC5B,SAAS,EAAE,OAAO,CAAC,SAAS;aAC7B,CAAC;YACF,IAAI,SAAS,EAAE,CAAC;gBACd,cAAc,CAAC,iBAAiB,CAAC,GAAG,SAAS,CAAC;YAChD,CAAC;YAED,MAAM,EAAE,IAAI,EAAE,cAAc,EAAE,GAAG,MAAA,aAAa,CAAC,aAAa,EAAE,OAAO,EAAE,cAAc,CAAC,mCAAI,EAAE,CAAC;YAE7F,IAAI,CAAC,IAAI,IAAI,CAAC,cAAc,EAAE,CAAC;gBAC7B,OAAO,IAAI,CAAC,OAAO,CAAC,CAAC;YACvB,CAAC;YAED,IAAI,CAAC;gBACH,MAAM,QAAQ,GAAG,MAAM,aAAa,CAAC,WAAW,CAAC,cAAc,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;gBAChF,kBAAkB,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;gBACnC,OAAO,QAAQ,CAAC;YAClB,CAAC;YAAC,OAAO,GAAQ,EAAE,CAAC;gBAClB,eAAe,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;gBAC3B,MAAM,GAAG,CAAC;YACZ,CAAC;QACH,CAAC;KACF,CAAC;AACJ,CAAC;AAED,SAAS,sBAAsB;IAC7B,IAAI,CAAC;QACH,OAAO,mBAAmB,CAAC;YACzB,SAAS,EAAE,EAAE;YACb,WAAW,EAAE,2BAA2B;YACxC,cAAc,EAAE,WAAW;SAC5B,CAAC,CAAC;IACL,CAAC;IAAC,OAAO,CAAU,EAAE,CAAC;QACpB,MAAM,CAAC,OAAO,CAAC,0CAA0C,eAAe,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;QAC/E,OAAO,SAAS,CAAC;IACnB,CAAC;AACH,CAAC;AAED,SAAS,aAAa,CACpB,aAA4B,EAC5B,OAAwB,EACxB,cAAuC;IAEvC,IAAI,CAAC;QACH,oFAAoF;QACpF,MAAM,EAAE,IAAI,EAAE,cAAc,EAAE,GAAG,aAAa,CAAC,SAAS,CACtD,QAAQ,OAAO,CAAC,MAAM,EAAE,EACxB,EAAE,cAAc,EAAE,OAAO,CAAC,cAAc,EAAE,EAC1C;YACE,QAAQ,EAAE,QAAQ;YAClB,cAAc;SACf,CACF,CAAC;QAEF,wDAAwD;QACxD,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,EAAE,CAAC;YACxB,IAAI,CAAC,GAAG,EAAE,CAAC;YACX,OAAO,SAAS,CAAC;QACnB,CAAC;QAED,cAAc;QACd,MAAM,OAAO,GAAG,aAAa,CAAC,oBAAoB,CAChD,cAAc,CAAC,cAAc,CAAC,cAAc,CAC7C,CAAC;QACF,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC;YACnD,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;QAClC,CAAC;QACD,OAAO,EAAE,IAAI,EAAE,cAAc,EAAE,cAAc,CAAC,cAAc,CAAC,cAAc,EAAE,CAAC;IAChF,CAAC;IAAC,OAAO,CAAM,EAAE,CAAC;QAChB,MAAM,CAAC,OAAO,CAAC,qDAAqD,eAAe,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;QAC1F,OAAO,SAAS,CAAC;IACnB,CAAC;AACH,CAAC;AAED,SAAS,eAAe,CAAC,IAAiB,EAAE,KAAc;IACxD,IAAI,CAAC;QACH,IAAI,CAAC,SAAS,CAAC;YACb,MAAM,EAAE,OAAO;YACf,KAAK,EAAE,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS;SAC1C,CAAC,CAAC;QACH,IAAI,WAAW,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,UAAU,EAAE,CAAC;YAC3C,IAAI,CAAC,YAAY,CAAC,kBAAkB,EAAE,KAAK,CAAC,UAAU,CAAC,CAAC;QAC1D,CAAC;QACD,IAAI,CAAC,GAAG,EAAE,CAAC;IACb,CAAC;IAAC,OAAO,CAAM,EAAE,CAAC;QAChB,MAAM,CAAC,OAAO,CAAC,qDAAqD,eAAe,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;IAC5F,CAAC;AACH,CAAC;AAED,SAAS,kBAAkB,CAAC,IAAiB,EAAE,QAA0B;IACvE,IAAI,CAAC;QACH,IAAI,CAAC,YAAY,CAAC,kBAAkB,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAC;QACvD,MAAM,gBAAgB,GAAG,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,iBAAiB,CAAC,CAAC;QACjE,IAAI,gBAAgB,EAAE,CAAC;YACrB,IAAI,CAAC,YAAY,CAAC,kBAAkB,EAAE,gBAAgB,CAAC,CAAC;QAC1D,CAAC;QACD,2FAA2F;QAC3F,2CAA2C;QAC3C,sEAAsE;QACtE,IAAI,QAAQ,CAAC,MAAM,IAAI,GAAG,EAAE,CAAC;YAC3B,IAAI,CAAC,SAAS,CAAC;gBACb,MAAM,EAAE,OAAO;aAChB,CAAC,CAAC;QACL,CAAC;QACD,IAAI,CAAC,GAAG,EAAE,CAAC;IACb,CAAC;IAAC,OAAO,CAAM,EAAE,CAAC;QAChB,MAAM,CAAC,OAAO,CAAC,qDAAqD,eAAe,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;IAC5F,CAAC;AACH,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport {\n type TracingClient,\n type TracingContext,\n type TracingSpan,\n createTracingClient,\n} from \"@azure/core-tracing\";\nimport { SDK_VERSION } from \"../constants.js\";\nimport type { PipelineRequest, PipelineResponse, SendRequest } from \"../interfaces.js\";\nimport type { PipelinePolicy } from \"../pipeline.js\";\nimport { getUserAgentValue } from \"../util/userAgent.js\";\nimport { logger } from \"../log.js\";\nimport { getErrorMessage, isError } from \"@azure/core-util\";\nimport { isRestError } from \"../restError.js\";\nimport { Sanitizer } from \"../util/sanitizer.js\";\n\n/**\n * The programmatic identifier of the tracingPolicy.\n */\nexport const tracingPolicyName = \"tracingPolicy\";\n\n/**\n * Options to configure the tracing policy.\n */\nexport interface TracingPolicyOptions {\n /**\n * String prefix to add to the user agent logged as metadata\n * on the generated Span.\n * Defaults to an empty string.\n */\n userAgentPrefix?: string;\n /**\n * Query string names whose values will be logged when logging is enabled. By default no\n * query string values are logged.\n */\n additionalAllowedQueryParameters?: string[];\n}\n\n/**\n * A simple policy to create OpenTelemetry Spans for each request made by the pipeline\n * that has SpanOptions with a parent.\n * Requests made without a parent Span will not be recorded.\n * @param options - Options to configure the telemetry logged by the tracing policy.\n */\nexport function tracingPolicy(options: TracingPolicyOptions = {}): PipelinePolicy {\n const userAgentPromise = getUserAgentValue(options.userAgentPrefix);\n const sanitizer = new Sanitizer({\n additionalAllowedQueryParameters: options.additionalAllowedQueryParameters,\n });\n const tracingClient = tryCreateTracingClient();\n\n return {\n name: tracingPolicyName,\n async sendRequest(request: PipelineRequest, next: SendRequest): Promise {\n if (!tracingClient) {\n return next(request);\n }\n\n const userAgent = await userAgentPromise;\n\n const spanAttributes = {\n \"http.url\": sanitizer.sanitizeUrl(request.url),\n \"http.method\": request.method,\n \"http.user_agent\": userAgent,\n requestId: request.requestId,\n };\n if (userAgent) {\n spanAttributes[\"http.user_agent\"] = userAgent;\n }\n\n const { span, tracingContext } = tryCreateSpan(tracingClient, request, spanAttributes) ?? {};\n\n if (!span || !tracingContext) {\n return next(request);\n }\n\n try {\n const response = await tracingClient.withContext(tracingContext, next, request);\n tryProcessResponse(span, response);\n return response;\n } catch (err: any) {\n tryProcessError(span, err);\n throw err;\n }\n },\n };\n}\n\nfunction tryCreateTracingClient(): TracingClient | undefined {\n try {\n return createTracingClient({\n namespace: \"\",\n packageName: \"@azure/core-rest-pipeline\",\n packageVersion: SDK_VERSION,\n });\n } catch (e: unknown) {\n logger.warning(`Error when creating the TracingClient: ${getErrorMessage(e)}`);\n return undefined;\n }\n}\n\nfunction tryCreateSpan(\n tracingClient: TracingClient,\n request: PipelineRequest,\n spanAttributes: Record,\n): { span: TracingSpan; tracingContext: TracingContext } | undefined {\n try {\n // As per spec, we do not need to differentiate between HTTP and HTTPS in span name.\n const { span, updatedOptions } = tracingClient.startSpan(\n `HTTP ${request.method}`,\n { tracingOptions: request.tracingOptions },\n {\n spanKind: \"client\",\n spanAttributes,\n },\n );\n\n // If the span is not recording, don't do any more work.\n if (!span.isRecording()) {\n span.end();\n return undefined;\n }\n\n // set headers\n const headers = tracingClient.createRequestHeaders(\n updatedOptions.tracingOptions.tracingContext,\n );\n for (const [key, value] of Object.entries(headers)) {\n request.headers.set(key, value);\n }\n return { span, tracingContext: updatedOptions.tracingOptions.tracingContext };\n } catch (e: any) {\n logger.warning(`Skipping creating a tracing span due to an error: ${getErrorMessage(e)}`);\n return undefined;\n }\n}\n\nfunction tryProcessError(span: TracingSpan, error: unknown): void {\n try {\n span.setStatus({\n status: \"error\",\n error: isError(error) ? error : undefined,\n });\n if (isRestError(error) && error.statusCode) {\n span.setAttribute(\"http.status_code\", error.statusCode);\n }\n span.end();\n } catch (e: any) {\n logger.warning(`Skipping tracing span processing due to an error: ${getErrorMessage(e)}`);\n }\n}\n\nfunction tryProcessResponse(span: TracingSpan, response: PipelineResponse): void {\n try {\n span.setAttribute(\"http.status_code\", response.status);\n const serviceRequestId = response.headers.get(\"x-ms-request-id\");\n if (serviceRequestId) {\n span.setAttribute(\"serviceRequestId\", serviceRequestId);\n }\n // Per semantic conventions, only set the status to error if the status code is 4xx or 5xx.\n // Otherwise, the status MUST remain unset.\n // https://opentelemetry.io/docs/specs/semconv/http/http-spans/#status\n if (response.status >= 400) {\n span.setStatus({\n status: \"error\",\n });\n }\n span.end();\n } catch (e: any) {\n logger.warning(`Skipping tracing span processing due to an error: ${getErrorMessage(e)}`);\n }\n}\n"]} \ No newline at end of file diff --git a/node_modules/@azure/core-rest-pipeline/dist/esm/restError.d.ts b/node_modules/@azure/core-rest-pipeline/dist/esm/restError.d.ts index 0bb2fc48..66264448 100644 --- a/node_modules/@azure/core-rest-pipeline/dist/esm/restError.d.ts +++ b/node_modules/@azure/core-rest-pipeline/dist/esm/restError.d.ts @@ -24,6 +24,7 @@ export interface RestErrorOptions { * A custom error type for failed pipeline requests. */ export declare class RestError extends Error { + [x: symbol]: () => string; /** * Something went wrong when making the request. * This means the actual request failed for some reason, diff --git a/node_modules/@azure/core-rest-pipeline/dist/esm/restError.d.ts.map b/node_modules/@azure/core-rest-pipeline/dist/esm/restError.d.ts.map index d6e29e6c..a10965e3 100644 --- a/node_modules/@azure/core-rest-pipeline/dist/esm/restError.d.ts.map +++ b/node_modules/@azure/core-rest-pipeline/dist/esm/restError.d.ts.map @@ -1 +1 @@ -{"version":3,"file":"restError.d.ts","sourceRoot":"","sources":["../../src/restError.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,eAAe,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAC;AAMzE;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,OAAO,CAAC,EAAE,eAAe,CAAC;IAC1B;;OAEG;IACH,QAAQ,CAAC,EAAE,gBAAgB,CAAC;CAC7B;AAED;;GAEG;AACH,qBAAa,SAAU,SAAQ,KAAK;IAClC;;;;OAIG;IACH,MAAM,CAAC,QAAQ,CAAC,kBAAkB,EAAE,MAAM,CAAwB;IAClE;;;OAGG;IACH,MAAM,CAAC,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAiB;IAEpD;;OAEG;IACI,IAAI,CAAC,EAAE,MAAM,CAAC;IACrB;;OAEG;IACI,UAAU,CAAC,EAAE,MAAM,CAAC;IAC3B;;;OAGG;IACI,OAAO,CAAC,EAAE,eAAe,CAAC;IACjC;;;OAGG;IACI,QAAQ,CAAC,EAAE,gBAAgB,CAAC;IACnC;;OAEG;IACI,OAAO,CAAC,EAAE,OAAO,CAAC;gBAEb,OAAO,EAAE,MAAM,EAAE,OAAO,GAAE,gBAAqB;CA4B5D;AAED;;;GAGG;AACH,wBAAgB,WAAW,CAAC,CAAC,EAAE,OAAO,GAAG,CAAC,IAAI,SAAS,CAKtD"} \ No newline at end of file +{"version":3,"file":"restError.d.ts","sourceRoot":"","sources":["../../src/restError.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,eAAe,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAC;AAMzE;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,OAAO,CAAC,EAAE,eAAe,CAAC;IAC1B;;OAEG;IACH,QAAQ,CAAC,EAAE,gBAAgB,CAAC;CAC7B;AAED;;GAEG;AACH,qBAAa,SAAU,SAAQ,KAAK;uBAuDtB,MAAM;IAtDlB;;;;OAIG;IACH,MAAM,CAAC,QAAQ,CAAC,kBAAkB,EAAE,MAAM,CAAwB;IAClE;;;OAGG;IACH,MAAM,CAAC,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAiB;IAEpD;;OAEG;IACI,IAAI,CAAC,EAAE,MAAM,CAAC;IACrB;;OAEG;IACI,UAAU,CAAC,EAAE,MAAM,CAAC;IAC3B;;;OAGG;IACI,OAAO,CAAC,EAAE,eAAe,CAAC;IACjC;;;OAGG;IACI,QAAQ,CAAC,EAAE,gBAAgB,CAAC;IACnC;;OAEG;IACI,OAAO,CAAC,EAAE,OAAO,CAAC;gBAEb,OAAO,EAAE,MAAM,EAAE,OAAO,GAAE,gBAAqB;CA4B5D;AAED;;;GAGG;AACH,wBAAgB,WAAW,CAAC,CAAC,EAAE,OAAO,GAAG,CAAC,IAAI,SAAS,CAKtD"} \ No newline at end of file diff --git a/node_modules/@azure/core-rest-pipeline/dist/esm/util/file.d.ts.map b/node_modules/@azure/core-rest-pipeline/dist/esm/util/file.d.ts.map index 092797aa..d165dbda 100644 --- a/node_modules/@azure/core-rest-pipeline/dist/esm/util/file.d.ts.map +++ b/node_modules/@azure/core-rest-pipeline/dist/esm/util/file.d.ts.map @@ -1 +1 @@ -{"version":3,"file":"file.d.ts","sourceRoot":"","sources":["../../../src/util/file.ts"],"names":[],"mappings":"AAMA;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAC7B;AAED;;GAEG;AACH,MAAM,WAAW,2BAA4B,SAAQ,iBAAiB;IACpE;;;;;OAKG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAyCD;;;;;;GAMG;AACH,wBAAgB,aAAa,CAC3B,IAAI,EAAE,IAAI,GACT,MAAM,CAAC,cAAc,GAAG,cAAc,CAAC,UAAU,CAAC,GAAG,UAAU,CAMjE;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,oBAAoB,CAClC,MAAM,EAAE,MAAM,cAAc,CAAC,UAAU,CAAC,GAAG,MAAM,CAAC,cAAc,EAChE,IAAI,EAAE,MAAM,EACZ,OAAO,GAAE,2BAAgC,GACxC,IAAI,CAoBN;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,UAAU,CACxB,OAAO,EAAE,UAAU,EACnB,IAAI,EAAE,MAAM,EACZ,OAAO,GAAE,iBAAsB,GAC9B,IAAI,CAgBN"} \ No newline at end of file +{"version":3,"file":"file.d.ts","sourceRoot":"","sources":["../../../src/util/file.ts"],"names":[],"mappings":"AAMA;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAC7B;AAED;;GAEG;AACH,MAAM,WAAW,2BAA4B,SAAQ,iBAAiB;IACpE;;;;;OAKG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AA4CD;;;;;;GAMG;AACH,wBAAgB,aAAa,CAC3B,IAAI,EAAE,IAAI,GACT,MAAM,CAAC,cAAc,GAAG,cAAc,CAAC,UAAU,CAAC,GAAG,UAAU,CAMjE;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,oBAAoB,CAClC,MAAM,EAAE,MAAM,cAAc,CAAC,UAAU,CAAC,GAAG,MAAM,CAAC,cAAc,EAChE,IAAI,EAAE,MAAM,EACZ,OAAO,GAAE,2BAAgC,GACxC,IAAI,CAoBN;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,UAAU,CACxB,OAAO,EAAE,UAAU,EACnB,IAAI,EAAE,MAAM,EACZ,OAAO,GAAE,iBAAsB,GAC9B,IAAI,CAgBN"} \ No newline at end of file diff --git a/node_modules/@azure/core-rest-pipeline/dist/esm/util/file.js b/node_modules/@azure/core-rest-pipeline/dist/esm/util/file.js index a9af2dc5..0a26caa1 100644 --- a/node_modules/@azure/core-rest-pipeline/dist/esm/util/file.js +++ b/node_modules/@azure/core-rest-pipeline/dist/esm/util/file.js @@ -6,6 +6,9 @@ const unimplementedMethods = { arrayBuffer: () => { throw new Error("Not implemented"); }, + bytes: () => { + throw new Error("Not implemented"); + }, slice: () => { throw new Error("Not implemented"); }, diff --git a/node_modules/@azure/core-rest-pipeline/dist/esm/util/file.js.map b/node_modules/@azure/core-rest-pipeline/dist/esm/util/file.js.map index 87721d1a..05a0c7da 100644 --- a/node_modules/@azure/core-rest-pipeline/dist/esm/util/file.js.map +++ b/node_modules/@azure/core-rest-pipeline/dist/esm/util/file.js.map @@ -1 +1 @@ -{"version":3,"file":"file.js","sourceRoot":"","sources":["../../../src/util/file.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAElC,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAC9C,OAAO,EAAE,oBAAoB,EAAE,MAAM,iBAAiB,CAAC;AAoCvD,MAAM,oBAAoB,GAAG;IAC3B,WAAW,EAAE,GAAG,EAAE;QAChB,MAAM,IAAI,KAAK,CAAC,iBAAiB,CAAC,CAAC;IACrC,CAAC;IACD,KAAK,EAAE,GAAG,EAAE;QACV,MAAM,IAAI,KAAK,CAAC,iBAAiB,CAAC,CAAC;IACrC,CAAC;IACD,IAAI,EAAE,GAAG,EAAE;QACT,MAAM,IAAI,KAAK,CAAC,iBAAiB,CAAC,CAAC;IACrC,CAAC;CACF,CAAC;AAEF;;;;;;;;;;;;;GAaG;AACH,MAAM,UAAU,GAAkB,MAAM,CAAC,YAAY,CAAC,CAAC;AASvD,SAAS,aAAa,CAAC,CAAU;IAC/B,OAAO,OAAQ,CAAgB,CAAC,UAAU,CAAC,KAAK,UAAU,CAAC;AAC7D,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,aAAa,CAC3B,IAAU;IAEV,IAAI,aAAa,CAAC,IAAI,CAAC,EAAE,CAAC;QACxB,OAAO,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC;IAC5B,CAAC;SAAM,CAAC;QACN,OAAO,IAAI,CAAC,MAAM,EAAE,CAAC;IACvB,CAAC;AACH,CAAC;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,UAAU,oBAAoB,CAClC,MAAgE,EAChE,IAAY,EACZ,UAAuC,EAAE;;IAEzC,OAAO,gCACF,oBAAoB,KACvB,IAAI,EAAE,MAAA,OAAO,CAAC,IAAI,mCAAI,EAAE,EACxB,YAAY,EAAE,MAAA,OAAO,CAAC,YAAY,mCAAI,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,EAC1D,kBAAkB,EAAE,MAAA,OAAO,CAAC,kBAAkB,mCAAI,EAAE,EACpD,IAAI,EAAE,MAAA,OAAO,CAAC,IAAI,mCAAI,CAAC,CAAC,EACxB,IAAI,EACJ,MAAM,EAAE,GAAG,EAAE;YACX,MAAM,CAAC,GAAG,MAAM,EAAE,CAAC;YACnB,IAAI,oBAAoB,CAAC,CAAC,CAAC,EAAE,CAAC;gBAC5B,MAAM,IAAI,KAAK,CACb,6EAA6E,CAC9E,CAAC;YACJ,CAAC;YAED,OAAO,CAAC,CAAC;QACX,CAAC,EACD,CAAC,UAAU,CAAC,EAAE,MAAM,GACA,CAAC;AACzB,CAAC;AAED;;;;;;;;;;GAUG;AACH,MAAM,UAAU,UAAU,CACxB,OAAmB,EACnB,IAAY,EACZ,UAA6B,EAAE;;IAE/B,IAAI,UAAU,EAAE,CAAC;QACf,OAAO,gCACF,oBAAoB,KACvB,IAAI,EAAE,MAAA,OAAO,CAAC,IAAI,mCAAI,EAAE,EACxB,YAAY,EAAE,MAAA,OAAO,CAAC,YAAY,mCAAI,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,EAC1D,kBAAkB,EAAE,MAAA,OAAO,CAAC,kBAAkB,mCAAI,EAAE,EACpD,IAAI,EAAE,OAAO,CAAC,UAAU,EACxB,IAAI,EACJ,WAAW,EAAE,KAAK,IAAI,EAAE,CAAC,OAAO,CAAC,MAAM,EACvC,MAAM,EAAE,GAAG,EAAE,CAAC,IAAI,IAAI,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,EAAE,EAC1C,CAAC,UAAU,CAAC,EAAE,GAAG,EAAE,CAAC,OAAO,GACP,CAAC;IACzB,CAAC;SAAM,CAAC;QACN,OAAO,IAAI,IAAI,CAAC,CAAC,OAAO,CAAC,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;IAC5C,CAAC;AACH,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport { isNodeLike } from \"@azure/core-util\";\nimport { isNodeReadableStream } from \"./typeGuards.js\";\n\n/**\n * Options passed into createFile specifying metadata about the file.\n */\nexport interface CreateFileOptions {\n /**\n * The MIME type of the file.\n */\n type?: string;\n\n /**\n * Last modified time of the file as a UNIX timestamp.\n * This will default to the current date.\n */\n lastModified?: number;\n\n /**\n * relative path of this file when uploading a directory.\n */\n webkitRelativePath?: string;\n}\n\n/**\n * Extra options for createFile when a stream is being passed in.\n */\nexport interface CreateFileFromStreamOptions extends CreateFileOptions {\n /**\n * Size of the file represented by the stream in bytes.\n *\n * This will be used by the pipeline when calculating the Content-Length header\n * for the overall request.\n */\n size?: number;\n}\n\nconst unimplementedMethods = {\n arrayBuffer: () => {\n throw new Error(\"Not implemented\");\n },\n slice: () => {\n throw new Error(\"Not implemented\");\n },\n text: () => {\n throw new Error(\"Not implemented\");\n },\n};\n\n/**\n * Private symbol used as key on objects created using createFile containing the\n * original source of the file object.\n *\n * This is used in Node to access the original Node stream without using Blob#stream, which\n * returns a web stream. This is done to avoid a couple of bugs to do with Blob#stream and\n * Readable#to/fromWeb in Node versions we support:\n * - https://github.com/nodejs/node/issues/42694 (fixed in Node 18.14)\n * - https://github.com/nodejs/node/issues/48916 (fixed in Node 20.6)\n *\n * Once these versions are no longer supported, we may be able to stop doing this.\n *\n * @internal\n */\nconst rawContent: unique symbol = Symbol(\"rawContent\");\n\n/**\n * Type signature of a blob-like object with a raw content property.\n */\ninterface RawContent {\n [rawContent](): Uint8Array | NodeJS.ReadableStream | ReadableStream;\n}\n\nfunction hasRawContent(x: unknown): x is RawContent {\n return typeof (x as RawContent)[rawContent] === \"function\";\n}\n\n/**\n * Extract the raw content from a given blob-like object. If the input was created using createFile\n * or createFileFromStream, the exact content passed into createFile/createFileFromStream will be used.\n * For true instances of Blob and File, returns the blob's content as a Web ReadableStream.\n *\n * @internal\n */\nexport function getRawContent(\n blob: Blob,\n): NodeJS.ReadableStream | ReadableStream | Uint8Array {\n if (hasRawContent(blob)) {\n return blob[rawContent]();\n } else {\n return blob.stream();\n }\n}\n\n/**\n * Create an object that implements the File interface. This object is intended to be\n * passed into RequestBodyType.formData, and is not guaranteed to work as expected in\n * other situations.\n *\n * Use this function to:\n * - Create a File object for use in RequestBodyType.formData in environments where the\n * global File object is unavailable.\n * - Create a File-like object from a readable stream without reading the stream into memory.\n *\n * @param stream - the content of the file as a callback returning a stream. When a File object made using createFile is\n * passed in a request's form data map, the stream will not be read into memory\n * and instead will be streamed when the request is made. In the event of a retry, the\n * stream needs to be read again, so this callback SHOULD return a fresh stream if possible.\n * @param name - the name of the file.\n * @param options - optional metadata about the file, e.g. file name, file size, MIME type.\n */\nexport function createFileFromStream(\n stream: () => ReadableStream | NodeJS.ReadableStream,\n name: string,\n options: CreateFileFromStreamOptions = {},\n): File {\n return {\n ...unimplementedMethods,\n type: options.type ?? \"\",\n lastModified: options.lastModified ?? new Date().getTime(),\n webkitRelativePath: options.webkitRelativePath ?? \"\",\n size: options.size ?? -1,\n name,\n stream: () => {\n const s = stream();\n if (isNodeReadableStream(s)) {\n throw new Error(\n \"Not supported: a Node stream was provided as input to createFileFromStream.\",\n );\n }\n\n return s;\n },\n [rawContent]: stream,\n } as File & RawContent;\n}\n\n/**\n * Create an object that implements the File interface. This object is intended to be\n * passed into RequestBodyType.formData, and is not guaranteed to work as expected in\n * other situations.\n *\n * Use this function create a File object for use in RequestBodyType.formData in environments where the global File object is unavailable.\n *\n * @param content - the content of the file as a Uint8Array in memory.\n * @param name - the name of the file.\n * @param options - optional metadata about the file, e.g. file name, file size, MIME type.\n */\nexport function createFile(\n content: Uint8Array,\n name: string,\n options: CreateFileOptions = {},\n): File {\n if (isNodeLike) {\n return {\n ...unimplementedMethods,\n type: options.type ?? \"\",\n lastModified: options.lastModified ?? new Date().getTime(),\n webkitRelativePath: options.webkitRelativePath ?? \"\",\n size: content.byteLength,\n name,\n arrayBuffer: async () => content.buffer,\n stream: () => new Blob([content]).stream(),\n [rawContent]: () => content,\n } as File & RawContent;\n } else {\n return new File([content], name, options);\n }\n}\n"]} \ No newline at end of file +{"version":3,"file":"file.js","sourceRoot":"","sources":["../../../src/util/file.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAElC,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAC9C,OAAO,EAAE,oBAAoB,EAAE,MAAM,iBAAiB,CAAC;AAoCvD,MAAM,oBAAoB,GAAG;IAC3B,WAAW,EAAE,GAAG,EAAE;QAChB,MAAM,IAAI,KAAK,CAAC,iBAAiB,CAAC,CAAC;IACrC,CAAC;IACD,KAAK,EAAE,GAAG,EAAE;QACV,MAAM,IAAI,KAAK,CAAC,iBAAiB,CAAC,CAAC;IACrC,CAAC;IACD,KAAK,EAAE,GAAG,EAAE;QACV,MAAM,IAAI,KAAK,CAAC,iBAAiB,CAAC,CAAC;IACrC,CAAC;IACD,IAAI,EAAE,GAAG,EAAE;QACT,MAAM,IAAI,KAAK,CAAC,iBAAiB,CAAC,CAAC;IACrC,CAAC;CACF,CAAC;AAEF;;;;;;;;;;;;;GAaG;AACH,MAAM,UAAU,GAAkB,MAAM,CAAC,YAAY,CAAC,CAAC;AASvD,SAAS,aAAa,CAAC,CAAU;IAC/B,OAAO,OAAQ,CAAgB,CAAC,UAAU,CAAC,KAAK,UAAU,CAAC;AAC7D,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,aAAa,CAC3B,IAAU;IAEV,IAAI,aAAa,CAAC,IAAI,CAAC,EAAE,CAAC;QACxB,OAAO,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC;IAC5B,CAAC;SAAM,CAAC;QACN,OAAO,IAAI,CAAC,MAAM,EAAE,CAAC;IACvB,CAAC;AACH,CAAC;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,UAAU,oBAAoB,CAClC,MAAgE,EAChE,IAAY,EACZ,UAAuC,EAAE;;IAEzC,OAAO,gCACF,oBAAoB,KACvB,IAAI,EAAE,MAAA,OAAO,CAAC,IAAI,mCAAI,EAAE,EACxB,YAAY,EAAE,MAAA,OAAO,CAAC,YAAY,mCAAI,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,EAC1D,kBAAkB,EAAE,MAAA,OAAO,CAAC,kBAAkB,mCAAI,EAAE,EACpD,IAAI,EAAE,MAAA,OAAO,CAAC,IAAI,mCAAI,CAAC,CAAC,EACxB,IAAI,EACJ,MAAM,EAAE,GAAG,EAAE;YACX,MAAM,CAAC,GAAG,MAAM,EAAE,CAAC;YACnB,IAAI,oBAAoB,CAAC,CAAC,CAAC,EAAE,CAAC;gBAC5B,MAAM,IAAI,KAAK,CACb,6EAA6E,CAC9E,CAAC;YACJ,CAAC;YAED,OAAO,CAAC,CAAC;QACX,CAAC,EACD,CAAC,UAAU,CAAC,EAAE,MAAM,GACA,CAAC;AACzB,CAAC;AAED;;;;;;;;;;GAUG;AACH,MAAM,UAAU,UAAU,CACxB,OAAmB,EACnB,IAAY,EACZ,UAA6B,EAAE;;IAE/B,IAAI,UAAU,EAAE,CAAC;QACf,OAAO,gCACF,oBAAoB,KACvB,IAAI,EAAE,MAAA,OAAO,CAAC,IAAI,mCAAI,EAAE,EACxB,YAAY,EAAE,MAAA,OAAO,CAAC,YAAY,mCAAI,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,EAC1D,kBAAkB,EAAE,MAAA,OAAO,CAAC,kBAAkB,mCAAI,EAAE,EACpD,IAAI,EAAE,OAAO,CAAC,UAAU,EACxB,IAAI,EACJ,WAAW,EAAE,KAAK,IAAI,EAAE,CAAC,OAAO,CAAC,MAAM,EACvC,MAAM,EAAE,GAAG,EAAE,CAAC,IAAI,IAAI,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,EAAE,EAC1C,CAAC,UAAU,CAAC,EAAE,GAAG,EAAE,CAAC,OAAO,GACP,CAAC;IACzB,CAAC;SAAM,CAAC;QACN,OAAO,IAAI,IAAI,CAAC,CAAC,OAAO,CAAC,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;IAC5C,CAAC;AACH,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport { isNodeLike } from \"@azure/core-util\";\nimport { isNodeReadableStream } from \"./typeGuards.js\";\n\n/**\n * Options passed into createFile specifying metadata about the file.\n */\nexport interface CreateFileOptions {\n /**\n * The MIME type of the file.\n */\n type?: string;\n\n /**\n * Last modified time of the file as a UNIX timestamp.\n * This will default to the current date.\n */\n lastModified?: number;\n\n /**\n * relative path of this file when uploading a directory.\n */\n webkitRelativePath?: string;\n}\n\n/**\n * Extra options for createFile when a stream is being passed in.\n */\nexport interface CreateFileFromStreamOptions extends CreateFileOptions {\n /**\n * Size of the file represented by the stream in bytes.\n *\n * This will be used by the pipeline when calculating the Content-Length header\n * for the overall request.\n */\n size?: number;\n}\n\nconst unimplementedMethods = {\n arrayBuffer: () => {\n throw new Error(\"Not implemented\");\n },\n bytes: () => {\n throw new Error(\"Not implemented\");\n },\n slice: () => {\n throw new Error(\"Not implemented\");\n },\n text: () => {\n throw new Error(\"Not implemented\");\n },\n};\n\n/**\n * Private symbol used as key on objects created using createFile containing the\n * original source of the file object.\n *\n * This is used in Node to access the original Node stream without using Blob#stream, which\n * returns a web stream. This is done to avoid a couple of bugs to do with Blob#stream and\n * Readable#to/fromWeb in Node versions we support:\n * - https://github.com/nodejs/node/issues/42694 (fixed in Node 18.14)\n * - https://github.com/nodejs/node/issues/48916 (fixed in Node 20.6)\n *\n * Once these versions are no longer supported, we may be able to stop doing this.\n *\n * @internal\n */\nconst rawContent: unique symbol = Symbol(\"rawContent\");\n\n/**\n * Type signature of a blob-like object with a raw content property.\n */\ninterface RawContent {\n [rawContent](): Uint8Array | NodeJS.ReadableStream | ReadableStream;\n}\n\nfunction hasRawContent(x: unknown): x is RawContent {\n return typeof (x as RawContent)[rawContent] === \"function\";\n}\n\n/**\n * Extract the raw content from a given blob-like object. If the input was created using createFile\n * or createFileFromStream, the exact content passed into createFile/createFileFromStream will be used.\n * For true instances of Blob and File, returns the blob's content as a Web ReadableStream.\n *\n * @internal\n */\nexport function getRawContent(\n blob: Blob,\n): NodeJS.ReadableStream | ReadableStream | Uint8Array {\n if (hasRawContent(blob)) {\n return blob[rawContent]();\n } else {\n return blob.stream();\n }\n}\n\n/**\n * Create an object that implements the File interface. This object is intended to be\n * passed into RequestBodyType.formData, and is not guaranteed to work as expected in\n * other situations.\n *\n * Use this function to:\n * - Create a File object for use in RequestBodyType.formData in environments where the\n * global File object is unavailable.\n * - Create a File-like object from a readable stream without reading the stream into memory.\n *\n * @param stream - the content of the file as a callback returning a stream. When a File object made using createFile is\n * passed in a request's form data map, the stream will not be read into memory\n * and instead will be streamed when the request is made. In the event of a retry, the\n * stream needs to be read again, so this callback SHOULD return a fresh stream if possible.\n * @param name - the name of the file.\n * @param options - optional metadata about the file, e.g. file name, file size, MIME type.\n */\nexport function createFileFromStream(\n stream: () => ReadableStream | NodeJS.ReadableStream,\n name: string,\n options: CreateFileFromStreamOptions = {},\n): File {\n return {\n ...unimplementedMethods,\n type: options.type ?? \"\",\n lastModified: options.lastModified ?? new Date().getTime(),\n webkitRelativePath: options.webkitRelativePath ?? \"\",\n size: options.size ?? -1,\n name,\n stream: () => {\n const s = stream();\n if (isNodeReadableStream(s)) {\n throw new Error(\n \"Not supported: a Node stream was provided as input to createFileFromStream.\",\n );\n }\n\n return s;\n },\n [rawContent]: stream,\n } as File & RawContent;\n}\n\n/**\n * Create an object that implements the File interface. This object is intended to be\n * passed into RequestBodyType.formData, and is not guaranteed to work as expected in\n * other situations.\n *\n * Use this function create a File object for use in RequestBodyType.formData in environments where the global File object is unavailable.\n *\n * @param content - the content of the file as a Uint8Array in memory.\n * @param name - the name of the file.\n * @param options - optional metadata about the file, e.g. file name, file size, MIME type.\n */\nexport function createFile(\n content: Uint8Array,\n name: string,\n options: CreateFileOptions = {},\n): File {\n if (isNodeLike) {\n return {\n ...unimplementedMethods,\n type: options.type ?? \"\",\n lastModified: options.lastModified ?? new Date().getTime(),\n webkitRelativePath: options.webkitRelativePath ?? \"\",\n size: content.byteLength,\n name,\n arrayBuffer: async () => content.buffer,\n stream: () => new Blob([content]).stream(),\n [rawContent]: () => content,\n } as File & RawContent;\n } else {\n return new File([content], name, options);\n }\n}\n"]} \ No newline at end of file diff --git a/node_modules/@azure/core-rest-pipeline/dist/react-native/constants.js b/node_modules/@azure/core-rest-pipeline/dist/react-native/constants.js index 6374dd08..f120876f 100644 --- a/node_modules/@azure/core-rest-pipeline/dist/react-native/constants.js +++ b/node_modules/@azure/core-rest-pipeline/dist/react-native/constants.js @@ -1,5 +1,5 @@ // Copyright (c) Microsoft Corporation. // Licensed under the MIT License. -export const SDK_VERSION = "1.18.1"; +export const SDK_VERSION = "1.18.2"; export const DEFAULT_RETRY_POLICY_COUNT = 3; //# sourceMappingURL=constants.js.map \ No newline at end of file diff --git a/node_modules/@azure/core-rest-pipeline/dist/react-native/constants.js.map b/node_modules/@azure/core-rest-pipeline/dist/react-native/constants.js.map index fc8b953a..9db3903f 100644 --- a/node_modules/@azure/core-rest-pipeline/dist/react-native/constants.js.map +++ b/node_modules/@azure/core-rest-pipeline/dist/react-native/constants.js.map @@ -1 +1 @@ -{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../src/constants.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAElC,MAAM,CAAC,MAAM,WAAW,GAAW,QAAQ,CAAC;AAE5C,MAAM,CAAC,MAAM,0BAA0B,GAAG,CAAC,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nexport const SDK_VERSION: string = \"1.18.1\";\n\nexport const DEFAULT_RETRY_POLICY_COUNT = 3;\n"]} \ No newline at end of file +{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../src/constants.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAElC,MAAM,CAAC,MAAM,WAAW,GAAW,QAAQ,CAAC;AAE5C,MAAM,CAAC,MAAM,0BAA0B,GAAG,CAAC,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nexport const SDK_VERSION: string = \"1.18.2\";\n\nexport const DEFAULT_RETRY_POLICY_COUNT = 3;\n"]} \ No newline at end of file diff --git a/node_modules/@azure/core-rest-pipeline/dist/react-native/index.d.ts.map b/node_modules/@azure/core-rest-pipeline/dist/react-native/index.d.ts.map index f8bb1e79..1f8d8a55 100644 --- a/node_modules/@azure/core-rest-pipeline/dist/react-native/index.d.ts.map +++ b/node_modules/@azure/core-rest-pipeline/dist/react-native/index.d.ts.map @@ -1 +1 @@ -{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAIA,OAAO,CAAC,MAAM,CAAC;IACb,UAAU,QAAQ;KAAG;IACrB,UAAU,IAAI;KAAG;IACjB,UAAU,IAAI;KAAG;IACjB,UAAU,cAAc,CAAC,CAAC,GAAG,GAAG;KAAI;IACpC,UAAU,eAAe,CAAC,CAAC,GAAG,GAAG,EAAE,CAAC,GAAG,GAAG;KAAI;CAC/C;AAGD,YAAY,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AACpD,YAAY,EACV,KAAK,EACL,QAAQ,EACR,WAAW,EACX,aAAa,EACb,UAAU,EACV,WAAW,EACX,SAAS,EACT,oBAAoB,EACpB,eAAe,EACf,gBAAgB,EAChB,oBAAoB,EACpB,aAAa,EACb,SAAS,EACT,cAAc,EACd,mBAAmB,EACnB,eAAe,EACf,WAAW,EACX,WAAW,EACX,qBAAqB,GACtB,MAAM,iBAAiB,CAAC;AACzB,OAAO,EACL,KAAK,gBAAgB,IAAI,kBAAkB,EAC3C,KAAK,aAAa,EAClB,KAAK,cAAc,EACnB,KAAK,QAAQ,EACb,mBAAmB,GACpB,MAAM,eAAe,CAAC;AACvB,OAAO,EACL,yBAAyB,EACzB,KAAK,gBAAgB,EACrB,KAAK,uBAAuB,EAC5B,KAAK,eAAe,GACrB,MAAM,gCAAgC,CAAC;AACxC,OAAO,EAAE,uBAAuB,EAAE,MAAM,wBAAwB,CAAC;AACjE,OAAO,EAAE,iBAAiB,EAAE,MAAM,kBAAkB,CAAC;AACrD,OAAO,EAAE,qBAAqB,EAAE,KAAK,sBAAsB,EAAE,MAAM,sBAAsB,CAAC;AAC1F,OAAO,EAAE,SAAS,EAAE,KAAK,gBAAgB,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAC/E,OAAO,EACL,wBAAwB,EACxB,4BAA4B,GAC7B,MAAM,wCAAwC,CAAC;AAChD,OAAO,EACL,sBAAsB,EACtB,KAAK,6BAA6B,EAClC,0BAA0B,GAC3B,MAAM,sCAAsC,CAAC;AAC9C,OAAO,EACL,wBAAwB,EACxB,4BAA4B,GAC7B,MAAM,wCAAwC,CAAC;AAChD,OAAO,EAAE,SAAS,EAAE,aAAa,EAAE,KAAK,gBAAgB,EAAE,MAAM,yBAAyB,CAAC;AAC1F,OAAO,EAAE,eAAe,EAAE,mBAAmB,EAAE,MAAM,+BAA+B,CAAC;AACrF,OAAO,EAAE,WAAW,EAAE,eAAe,EAAE,uBAAuB,EAAE,MAAM,2BAA2B,CAAC;AAClG,OAAO,EACL,cAAc,EACd,kBAAkB,EAClB,KAAK,qBAAqB,GAC3B,MAAM,8BAA8B,CAAC;AACtC,OAAO,EACL,sBAAsB,EACtB,KAAK,6BAA6B,EAClC,0BAA0B,GAC3B,MAAM,sCAAsC,CAAC;AAC9C,OAAO,EACL,qBAAqB,EACrB,yBAAyB,EACzB,KAAK,4BAA4B,GAClC,MAAM,qCAAqC,CAAC;AAC7C,OAAO,EAAE,WAAW,EAAE,KAAK,kBAAkB,EAAE,MAAM,2BAA2B,CAAC;AACjF,YAAY,EACV,aAAa,EACb,gBAAgB,EAChB,cAAc,GACf,MAAM,oCAAoC,CAAC;AAC5C,OAAO,EACL,aAAa,EACb,iBAAiB,EACjB,KAAK,oBAAoB,GAC1B,MAAM,6BAA6B,CAAC;AACrC,OAAO,EACL,kBAAkB,EAClB,KAAK,yBAAyB,GAC/B,MAAM,kCAAkC,CAAC;AAC1C,OAAO,EACL,eAAe,EACf,mBAAmB,EACnB,KAAK,sBAAsB,GAC5B,MAAM,+BAA+B,CAAC;AACvC,OAAO,EAAE,SAAS,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAC;AACnE,OAAO,EAAE,cAAc,EAAE,kBAAkB,EAAE,MAAM,8BAA8B,CAAC;AAClF,OAAO,EACL,+BAA+B,EAC/B,KAAK,sCAAsC,EAC3C,mCAAmC,EACnC,KAAK,kBAAkB,EACvB,KAAK,uBAAuB,EAC5B,KAAK,kCAAkC,GACxC,MAAM,+CAA+C,CAAC;AACvD,OAAO,EAAE,YAAY,EAAE,gBAAgB,EAAE,MAAM,4BAA4B,CAAC;AAC5E,OAAO,EACL,mCAAmC,EACnC,KAAK,0CAA0C,EAC/C,uCAAuC,GACxC,MAAM,mDAAmD,CAAC;AAC3D,OAAO,EACL,UAAU,EACV,oBAAoB,EACpB,KAAK,iBAAiB,EACtB,KAAK,2BAA2B,GACjC,MAAM,gBAAgB,CAAC"} \ No newline at end of file +{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAGA,OAAO,CAAC,MAAM,CAAC;IACb,UAAU,QAAQ;KAAG;IACrB,UAAU,IAAI;KAAG;IACjB,UAAU,IAAI;KAAG;IACjB,UAAU,cAAc,CAAC,CAAC,GAAG,GAAG;KAAI;IACpC,UAAU,eAAe,CAAC,CAAC,GAAG,GAAG,EAAE,CAAC,GAAG,GAAG;KAAI;CAC/C;AAED,YAAY,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AACpD,YAAY,EACV,KAAK,EACL,QAAQ,EACR,WAAW,EACX,aAAa,EACb,UAAU,EACV,WAAW,EACX,SAAS,EACT,oBAAoB,EACpB,eAAe,EACf,gBAAgB,EAChB,oBAAoB,EACpB,aAAa,EACb,SAAS,EACT,cAAc,EACd,mBAAmB,EACnB,eAAe,EACf,WAAW,EACX,WAAW,EACX,qBAAqB,GACtB,MAAM,iBAAiB,CAAC;AACzB,OAAO,EACL,KAAK,gBAAgB,IAAI,kBAAkB,EAC3C,KAAK,aAAa,EAClB,KAAK,cAAc,EACnB,KAAK,QAAQ,EACb,mBAAmB,GACpB,MAAM,eAAe,CAAC;AACvB,OAAO,EACL,yBAAyB,EACzB,KAAK,gBAAgB,EACrB,KAAK,uBAAuB,EAC5B,KAAK,eAAe,GACrB,MAAM,gCAAgC,CAAC;AACxC,OAAO,EAAE,uBAAuB,EAAE,MAAM,wBAAwB,CAAC;AACjE,OAAO,EAAE,iBAAiB,EAAE,MAAM,kBAAkB,CAAC;AACrD,OAAO,EAAE,qBAAqB,EAAE,KAAK,sBAAsB,EAAE,MAAM,sBAAsB,CAAC;AAC1F,OAAO,EAAE,SAAS,EAAE,KAAK,gBAAgB,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAC/E,OAAO,EACL,wBAAwB,EACxB,4BAA4B,GAC7B,MAAM,wCAAwC,CAAC;AAChD,OAAO,EACL,sBAAsB,EACtB,KAAK,6BAA6B,EAClC,0BAA0B,GAC3B,MAAM,sCAAsC,CAAC;AAC9C,OAAO,EACL,wBAAwB,EACxB,4BAA4B,GAC7B,MAAM,wCAAwC,CAAC;AAChD,OAAO,EAAE,SAAS,EAAE,aAAa,EAAE,KAAK,gBAAgB,EAAE,MAAM,yBAAyB,CAAC;AAC1F,OAAO,EAAE,eAAe,EAAE,mBAAmB,EAAE,MAAM,+BAA+B,CAAC;AACrF,OAAO,EAAE,WAAW,EAAE,eAAe,EAAE,uBAAuB,EAAE,MAAM,2BAA2B,CAAC;AAClG,OAAO,EACL,cAAc,EACd,kBAAkB,EAClB,KAAK,qBAAqB,GAC3B,MAAM,8BAA8B,CAAC;AACtC,OAAO,EACL,sBAAsB,EACtB,KAAK,6BAA6B,EAClC,0BAA0B,GAC3B,MAAM,sCAAsC,CAAC;AAC9C,OAAO,EACL,qBAAqB,EACrB,yBAAyB,EACzB,KAAK,4BAA4B,GAClC,MAAM,qCAAqC,CAAC;AAC7C,OAAO,EAAE,WAAW,EAAE,KAAK,kBAAkB,EAAE,MAAM,2BAA2B,CAAC;AACjF,YAAY,EACV,aAAa,EACb,gBAAgB,EAChB,cAAc,GACf,MAAM,oCAAoC,CAAC;AAC5C,OAAO,EACL,aAAa,EACb,iBAAiB,EACjB,KAAK,oBAAoB,GAC1B,MAAM,6BAA6B,CAAC;AACrC,OAAO,EACL,kBAAkB,EAClB,KAAK,yBAAyB,GAC/B,MAAM,kCAAkC,CAAC;AAC1C,OAAO,EACL,eAAe,EACf,mBAAmB,EACnB,KAAK,sBAAsB,GAC5B,MAAM,+BAA+B,CAAC;AACvC,OAAO,EAAE,SAAS,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAC;AACnE,OAAO,EAAE,cAAc,EAAE,kBAAkB,EAAE,MAAM,8BAA8B,CAAC;AAClF,OAAO,EACL,+BAA+B,EAC/B,KAAK,sCAAsC,EAC3C,mCAAmC,EACnC,KAAK,kBAAkB,EACvB,KAAK,uBAAuB,EAC5B,KAAK,kCAAkC,GACxC,MAAM,+CAA+C,CAAC;AACvD,OAAO,EAAE,YAAY,EAAE,gBAAgB,EAAE,MAAM,4BAA4B,CAAC;AAC5E,OAAO,EACL,mCAAmC,EACnC,KAAK,0CAA0C,EAC/C,uCAAuC,GACxC,MAAM,mDAAmD,CAAC;AAC3D,OAAO,EACL,UAAU,EACV,oBAAoB,EACpB,KAAK,iBAAiB,EACtB,KAAK,2BAA2B,GACjC,MAAM,gBAAgB,CAAC"} \ No newline at end of file diff --git a/node_modules/@azure/core-rest-pipeline/dist/react-native/index.js.map b/node_modules/@azure/core-rest-pipeline/dist/react-native/index.js.map index 52b04661..b19f3381 100644 --- a/node_modules/@azure/core-rest-pipeline/dist/react-native/index.js.map +++ b/node_modules/@azure/core-rest-pipeline/dist/react-native/index.js.map @@ -1 +1 @@ -{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAkClC,OAAO,EAKL,mBAAmB,GACpB,MAAM,eAAe,CAAC;AACvB,OAAO,EACL,yBAAyB,GAI1B,MAAM,gCAAgC,CAAC;AACxC,OAAO,EAAE,uBAAuB,EAAE,MAAM,wBAAwB,CAAC;AACjE,OAAO,EAAE,iBAAiB,EAAE,MAAM,kBAAkB,CAAC;AACrD,OAAO,EAAE,qBAAqB,EAA+B,MAAM,sBAAsB,CAAC;AAC1F,OAAO,EAAE,SAAS,EAAyB,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAC/E,OAAO,EACL,wBAAwB,EACxB,4BAA4B,GAC7B,MAAM,wCAAwC,CAAC;AAChD,OAAO,EACL,sBAAsB,EAEtB,0BAA0B,GAC3B,MAAM,sCAAsC,CAAC;AAC9C,OAAO,EACL,wBAAwB,EACxB,4BAA4B,GAC7B,MAAM,wCAAwC,CAAC;AAChD,OAAO,EAAE,SAAS,EAAE,aAAa,EAAyB,MAAM,yBAAyB,CAAC;AAC1F,OAAO,EAAE,eAAe,EAAE,mBAAmB,EAAE,MAAM,+BAA+B,CAAC;AACrF,OAAO,EAAE,WAAW,EAAE,eAAe,EAAE,uBAAuB,EAAE,MAAM,2BAA2B,CAAC;AAClG,OAAO,EACL,cAAc,EACd,kBAAkB,GAEnB,MAAM,8BAA8B,CAAC;AACtC,OAAO,EACL,sBAAsB,EAEtB,0BAA0B,GAC3B,MAAM,sCAAsC,CAAC;AAC9C,OAAO,EACL,qBAAqB,EACrB,yBAAyB,GAE1B,MAAM,qCAAqC,CAAC;AAC7C,OAAO,EAAE,WAAW,EAA2B,MAAM,2BAA2B,CAAC;AAMjF,OAAO,EACL,aAAa,EACb,iBAAiB,GAElB,MAAM,6BAA6B,CAAC;AACrC,OAAO,EACL,kBAAkB,GAEnB,MAAM,kCAAkC,CAAC;AAC1C,OAAO,EACL,eAAe,EACf,mBAAmB,GAEpB,MAAM,+BAA+B,CAAC;AACvC,OAAO,EAAE,SAAS,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAC;AACnE,OAAO,EAAE,cAAc,EAAE,kBAAkB,EAAE,MAAM,8BAA8B,CAAC;AAClF,OAAO,EACL,+BAA+B,EAE/B,mCAAmC,GAIpC,MAAM,+CAA+C,CAAC;AACvD,OAAO,EAAE,YAAY,EAAE,gBAAgB,EAAE,MAAM,4BAA4B,CAAC;AAC5E,OAAO,EACL,mCAAmC,EAEnC,uCAAuC,GACxC,MAAM,mDAAmD,CAAC;AAC3D,OAAO,EACL,UAAU,EACV,oBAAoB,GAGrB,MAAM,gBAAgB,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\n/* eslint-disable @typescript-eslint/no-unused-vars */\ndeclare global {\n interface FormData {}\n interface Blob {}\n interface File {}\n interface ReadableStream {}\n interface TransformStream {}\n}\n\n/* eslint-enable @typescript-eslint/no-unused-vars */\nexport type { HttpMethods } from \"@azure/core-util\";\nexport type {\n Agent,\n BodyPart,\n FormDataMap,\n FormDataValue,\n HttpClient,\n HttpHeaders,\n KeyObject,\n MultipartRequestBody,\n PipelineRequest,\n PipelineResponse,\n PipelineRetryOptions,\n ProxySettings,\n PxfObject,\n RawHttpHeaders,\n RawHttpHeadersInput,\n RequestBodyType,\n SendRequest,\n TlsSettings,\n TransferProgressEvent,\n} from \"./interfaces.js\";\nexport {\n type AddPolicyOptions as AddPipelineOptions,\n type PipelinePhase,\n type PipelinePolicy,\n type Pipeline,\n createEmptyPipeline,\n} from \"./pipeline.js\";\nexport {\n createPipelineFromOptions,\n type TelemetryOptions,\n type InternalPipelineOptions,\n type PipelineOptions,\n} from \"./createPipelineFromOptions.js\";\nexport { createDefaultHttpClient } from \"./defaultHttpClient.js\";\nexport { createHttpHeaders } from \"./httpHeaders.js\";\nexport { createPipelineRequest, type PipelineRequestOptions } from \"./pipelineRequest.js\";\nexport { RestError, type RestErrorOptions, isRestError } from \"./restError.js\";\nexport {\n decompressResponsePolicy,\n decompressResponsePolicyName,\n} from \"./policies/decompressResponsePolicy.js\";\nexport {\n exponentialRetryPolicy,\n type ExponentialRetryPolicyOptions,\n exponentialRetryPolicyName,\n} from \"./policies/exponentialRetryPolicy.js\";\nexport {\n setClientRequestIdPolicy,\n setClientRequestIdPolicyName,\n} from \"./policies/setClientRequestIdPolicy.js\";\nexport { logPolicy, logPolicyName, type LogPolicyOptions } from \"./policies/logPolicy.js\";\nexport { multipartPolicy, multipartPolicyName } from \"./policies/multipartPolicy.js\";\nexport { proxyPolicy, proxyPolicyName, getDefaultProxySettings } from \"./policies/proxyPolicy.js\";\nexport {\n redirectPolicy,\n redirectPolicyName,\n type RedirectPolicyOptions,\n} from \"./policies/redirectPolicy.js\";\nexport {\n systemErrorRetryPolicy,\n type SystemErrorRetryPolicyOptions,\n systemErrorRetryPolicyName,\n} from \"./policies/systemErrorRetryPolicy.js\";\nexport {\n throttlingRetryPolicy,\n throttlingRetryPolicyName,\n type ThrottlingRetryPolicyOptions,\n} from \"./policies/throttlingRetryPolicy.js\";\nexport { retryPolicy, type RetryPolicyOptions } from \"./policies/retryPolicy.js\";\nexport type {\n RetryStrategy,\n RetryInformation,\n RetryModifiers,\n} from \"./retryStrategies/retryStrategy.js\";\nexport {\n tracingPolicy,\n tracingPolicyName,\n type TracingPolicyOptions,\n} from \"./policies/tracingPolicy.js\";\nexport {\n defaultRetryPolicy,\n type DefaultRetryPolicyOptions,\n} from \"./policies/defaultRetryPolicy.js\";\nexport {\n userAgentPolicy,\n userAgentPolicyName,\n type UserAgentPolicyOptions,\n} from \"./policies/userAgentPolicy.js\";\nexport { tlsPolicy, tlsPolicyName } from \"./policies/tlsPolicy.js\";\nexport { formDataPolicy, formDataPolicyName } from \"./policies/formDataPolicy.js\";\nexport {\n bearerTokenAuthenticationPolicy,\n type BearerTokenAuthenticationPolicyOptions,\n bearerTokenAuthenticationPolicyName,\n type ChallengeCallbacks,\n type AuthorizeRequestOptions,\n type AuthorizeRequestOnChallengeOptions,\n} from \"./policies/bearerTokenAuthenticationPolicy.js\";\nexport { ndJsonPolicy, ndJsonPolicyName } from \"./policies/ndJsonPolicy.js\";\nexport {\n auxiliaryAuthenticationHeaderPolicy,\n type AuxiliaryAuthenticationHeaderPolicyOptions,\n auxiliaryAuthenticationHeaderPolicyName,\n} from \"./policies/auxiliaryAuthenticationHeaderPolicy.js\";\nexport {\n createFile,\n createFileFromStream,\n type CreateFileOptions,\n type CreateFileFromStreamOptions,\n} from \"./util/file.js\";\n"]} \ No newline at end of file +{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAgClC,OAAO,EAKL,mBAAmB,GACpB,MAAM,eAAe,CAAC;AACvB,OAAO,EACL,yBAAyB,GAI1B,MAAM,gCAAgC,CAAC;AACxC,OAAO,EAAE,uBAAuB,EAAE,MAAM,wBAAwB,CAAC;AACjE,OAAO,EAAE,iBAAiB,EAAE,MAAM,kBAAkB,CAAC;AACrD,OAAO,EAAE,qBAAqB,EAA+B,MAAM,sBAAsB,CAAC;AAC1F,OAAO,EAAE,SAAS,EAAyB,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAC/E,OAAO,EACL,wBAAwB,EACxB,4BAA4B,GAC7B,MAAM,wCAAwC,CAAC;AAChD,OAAO,EACL,sBAAsB,EAEtB,0BAA0B,GAC3B,MAAM,sCAAsC,CAAC;AAC9C,OAAO,EACL,wBAAwB,EACxB,4BAA4B,GAC7B,MAAM,wCAAwC,CAAC;AAChD,OAAO,EAAE,SAAS,EAAE,aAAa,EAAyB,MAAM,yBAAyB,CAAC;AAC1F,OAAO,EAAE,eAAe,EAAE,mBAAmB,EAAE,MAAM,+BAA+B,CAAC;AACrF,OAAO,EAAE,WAAW,EAAE,eAAe,EAAE,uBAAuB,EAAE,MAAM,2BAA2B,CAAC;AAClG,OAAO,EACL,cAAc,EACd,kBAAkB,GAEnB,MAAM,8BAA8B,CAAC;AACtC,OAAO,EACL,sBAAsB,EAEtB,0BAA0B,GAC3B,MAAM,sCAAsC,CAAC;AAC9C,OAAO,EACL,qBAAqB,EACrB,yBAAyB,GAE1B,MAAM,qCAAqC,CAAC;AAC7C,OAAO,EAAE,WAAW,EAA2B,MAAM,2BAA2B,CAAC;AAMjF,OAAO,EACL,aAAa,EACb,iBAAiB,GAElB,MAAM,6BAA6B,CAAC;AACrC,OAAO,EACL,kBAAkB,GAEnB,MAAM,kCAAkC,CAAC;AAC1C,OAAO,EACL,eAAe,EACf,mBAAmB,GAEpB,MAAM,+BAA+B,CAAC;AACvC,OAAO,EAAE,SAAS,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAC;AACnE,OAAO,EAAE,cAAc,EAAE,kBAAkB,EAAE,MAAM,8BAA8B,CAAC;AAClF,OAAO,EACL,+BAA+B,EAE/B,mCAAmC,GAIpC,MAAM,+CAA+C,CAAC;AACvD,OAAO,EAAE,YAAY,EAAE,gBAAgB,EAAE,MAAM,4BAA4B,CAAC;AAC5E,OAAO,EACL,mCAAmC,EAEnC,uCAAuC,GACxC,MAAM,mDAAmD,CAAC;AAC3D,OAAO,EACL,UAAU,EACV,oBAAoB,GAGrB,MAAM,gBAAgB,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\ndeclare global {\n interface FormData {}\n interface Blob {}\n interface File {}\n interface ReadableStream {}\n interface TransformStream {}\n}\n\nexport type { HttpMethods } from \"@azure/core-util\";\nexport type {\n Agent,\n BodyPart,\n FormDataMap,\n FormDataValue,\n HttpClient,\n HttpHeaders,\n KeyObject,\n MultipartRequestBody,\n PipelineRequest,\n PipelineResponse,\n PipelineRetryOptions,\n ProxySettings,\n PxfObject,\n RawHttpHeaders,\n RawHttpHeadersInput,\n RequestBodyType,\n SendRequest,\n TlsSettings,\n TransferProgressEvent,\n} from \"./interfaces.js\";\nexport {\n type AddPolicyOptions as AddPipelineOptions,\n type PipelinePhase,\n type PipelinePolicy,\n type Pipeline,\n createEmptyPipeline,\n} from \"./pipeline.js\";\nexport {\n createPipelineFromOptions,\n type TelemetryOptions,\n type InternalPipelineOptions,\n type PipelineOptions,\n} from \"./createPipelineFromOptions.js\";\nexport { createDefaultHttpClient } from \"./defaultHttpClient.js\";\nexport { createHttpHeaders } from \"./httpHeaders.js\";\nexport { createPipelineRequest, type PipelineRequestOptions } from \"./pipelineRequest.js\";\nexport { RestError, type RestErrorOptions, isRestError } from \"./restError.js\";\nexport {\n decompressResponsePolicy,\n decompressResponsePolicyName,\n} from \"./policies/decompressResponsePolicy.js\";\nexport {\n exponentialRetryPolicy,\n type ExponentialRetryPolicyOptions,\n exponentialRetryPolicyName,\n} from \"./policies/exponentialRetryPolicy.js\";\nexport {\n setClientRequestIdPolicy,\n setClientRequestIdPolicyName,\n} from \"./policies/setClientRequestIdPolicy.js\";\nexport { logPolicy, logPolicyName, type LogPolicyOptions } from \"./policies/logPolicy.js\";\nexport { multipartPolicy, multipartPolicyName } from \"./policies/multipartPolicy.js\";\nexport { proxyPolicy, proxyPolicyName, getDefaultProxySettings } from \"./policies/proxyPolicy.js\";\nexport {\n redirectPolicy,\n redirectPolicyName,\n type RedirectPolicyOptions,\n} from \"./policies/redirectPolicy.js\";\nexport {\n systemErrorRetryPolicy,\n type SystemErrorRetryPolicyOptions,\n systemErrorRetryPolicyName,\n} from \"./policies/systemErrorRetryPolicy.js\";\nexport {\n throttlingRetryPolicy,\n throttlingRetryPolicyName,\n type ThrottlingRetryPolicyOptions,\n} from \"./policies/throttlingRetryPolicy.js\";\nexport { retryPolicy, type RetryPolicyOptions } from \"./policies/retryPolicy.js\";\nexport type {\n RetryStrategy,\n RetryInformation,\n RetryModifiers,\n} from \"./retryStrategies/retryStrategy.js\";\nexport {\n tracingPolicy,\n tracingPolicyName,\n type TracingPolicyOptions,\n} from \"./policies/tracingPolicy.js\";\nexport {\n defaultRetryPolicy,\n type DefaultRetryPolicyOptions,\n} from \"./policies/defaultRetryPolicy.js\";\nexport {\n userAgentPolicy,\n userAgentPolicyName,\n type UserAgentPolicyOptions,\n} from \"./policies/userAgentPolicy.js\";\nexport { tlsPolicy, tlsPolicyName } from \"./policies/tlsPolicy.js\";\nexport { formDataPolicy, formDataPolicyName } from \"./policies/formDataPolicy.js\";\nexport {\n bearerTokenAuthenticationPolicy,\n type BearerTokenAuthenticationPolicyOptions,\n bearerTokenAuthenticationPolicyName,\n type ChallengeCallbacks,\n type AuthorizeRequestOptions,\n type AuthorizeRequestOnChallengeOptions,\n} from \"./policies/bearerTokenAuthenticationPolicy.js\";\nexport { ndJsonPolicy, ndJsonPolicyName } from \"./policies/ndJsonPolicy.js\";\nexport {\n auxiliaryAuthenticationHeaderPolicy,\n type AuxiliaryAuthenticationHeaderPolicyOptions,\n auxiliaryAuthenticationHeaderPolicyName,\n} from \"./policies/auxiliaryAuthenticationHeaderPolicy.js\";\nexport {\n createFile,\n createFileFromStream,\n type CreateFileOptions,\n type CreateFileFromStreamOptions,\n} from \"./util/file.js\";\n"]} \ No newline at end of file diff --git a/node_modules/@azure/core-rest-pipeline/dist/react-native/policies/retryPolicy.d.ts.map b/node_modules/@azure/core-rest-pipeline/dist/react-native/policies/retryPolicy.d.ts.map index d4afad3b..a94ed48e 100644 --- a/node_modules/@azure/core-rest-pipeline/dist/react-native/policies/retryPolicy.d.ts.map +++ b/node_modules/@azure/core-rest-pipeline/dist/react-native/policies/retryPolicy.d.ts.map @@ -1 +1 @@ -{"version":3,"file":"retryPolicy.d.ts","sourceRoot":"","sources":["../../../src/policies/retryPolicy.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAErD,OAAO,EAAE,KAAK,WAAW,EAAsB,MAAM,eAAe,CAAC;AACrE,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,qCAAqC,CAAC;AAYzE;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,MAAM,CAAC,EAAE,WAAW,CAAC;CACtB;AAED;;GAEG;AACH,wBAAgB,WAAW,CACzB,UAAU,EAAE,aAAa,EAAE,EAC3B,OAAO,GAAE,kBAA+D,GACvE,cAAc,CAmHhB"} \ No newline at end of file +{"version":3,"file":"retryPolicy.d.ts","sourceRoot":"","sources":["../../../src/policies/retryPolicy.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAErD,OAAO,EAAE,KAAK,WAAW,EAAsB,MAAM,eAAe,CAAC;AACrE,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,qCAAqC,CAAC;AAYzE;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,MAAM,CAAC,EAAE,WAAW,CAAC;CACtB;AAED;;GAEG;AACH,wBAAgB,WAAW,CACzB,UAAU,EAAE,aAAa,EAAE,EAC3B,OAAO,GAAE,kBAA+D,GACvE,cAAc,CAkHhB"} \ No newline at end of file diff --git a/node_modules/@azure/core-rest-pipeline/dist/react-native/policies/retryPolicy.js b/node_modules/@azure/core-rest-pipeline/dist/react-native/policies/retryPolicy.js index 9629aa29..7c16db75 100644 --- a/node_modules/@azure/core-rest-pipeline/dist/react-native/policies/retryPolicy.js +++ b/node_modules/@azure/core-rest-pipeline/dist/react-native/policies/retryPolicy.js @@ -21,7 +21,6 @@ export function retryPolicy(strategies, options = { maxRetries: DEFAULT_RETRY_PO let response; let responseError; let retryCount = -1; - // eslint-disable-next-line no-constant-condition retryRequest: while (true) { retryCount += 1; response = undefined; diff --git a/node_modules/@azure/core-rest-pipeline/dist/react-native/policies/retryPolicy.js.map b/node_modules/@azure/core-rest-pipeline/dist/react-native/policies/retryPolicy.js.map index 04b1b73d..51ba69b8 100644 --- a/node_modules/@azure/core-rest-pipeline/dist/react-native/policies/retryPolicy.js.map +++ b/node_modules/@azure/core-rest-pipeline/dist/react-native/policies/retryPolicy.js.map @@ -1 +1 @@ -{"version":3,"file":"retryPolicy.js","sourceRoot":"","sources":["../../../src/policies/retryPolicy.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAIlC,OAAO,EAAE,KAAK,EAAE,MAAM,oBAAoB,CAAC;AAC3C,OAAO,EAAoB,kBAAkB,EAAE,MAAM,eAAe,CAAC;AAGrE,OAAO,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAC;AACrD,OAAO,EAAE,0BAA0B,EAAE,MAAM,iBAAiB,CAAC;AAE7D,MAAM,iBAAiB,GAAG,kBAAkB,CAAC,gCAAgC,CAAC,CAAC;AAE/E;;GAEG;AACH,MAAM,eAAe,GAAG,aAAa,CAAC;AAgBtC;;GAEG;AACH,MAAM,UAAU,WAAW,CACzB,UAA2B,EAC3B,UAA8B,EAAE,UAAU,EAAE,0BAA0B,EAAE;IAExE,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,IAAI,iBAAiB,CAAC;IACnD,OAAO;QACL,IAAI,EAAE,eAAe;QACrB,KAAK,CAAC,WAAW,CAAC,OAAwB,EAAE,IAAiB;;YAC3D,IAAI,QAAsC,CAAC;YAC3C,IAAI,aAAoC,CAAC;YACzC,IAAI,UAAU,GAAG,CAAC,CAAC,CAAC;YAEpB,iDAAiD;YACjD,YAAY,EAAE,OAAO,IAAI,EAAE,CAAC;gBAC1B,UAAU,IAAI,CAAC,CAAC;gBAChB,QAAQ,GAAG,SAAS,CAAC;gBACrB,aAAa,GAAG,SAAS,CAAC;gBAE1B,IAAI,CAAC;oBACH,MAAM,CAAC,IAAI,CAAC,SAAS,UAAU,8BAA8B,EAAE,OAAO,CAAC,SAAS,CAAC,CAAC;oBAClF,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,CAAC;oBAC/B,MAAM,CAAC,IAAI,CAAC,SAAS,UAAU,oCAAoC,EAAE,OAAO,CAAC,SAAS,CAAC,CAAC;gBAC1F,CAAC;gBAAC,OAAO,CAAM,EAAE,CAAC;oBAChB,MAAM,CAAC,KAAK,CAAC,SAAS,UAAU,kCAAkC,EAAE,OAAO,CAAC,SAAS,CAAC,CAAC;oBAEvF,yDAAyD;oBACzD,gGAAgG;oBAChG,sEAAsE;oBACtE,aAAa,GAAG,CAAc,CAAC;oBAC/B,IAAI,CAAC,CAAC,IAAI,aAAa,CAAC,IAAI,KAAK,WAAW,EAAE,CAAC;wBAC7C,MAAM,CAAC,CAAC;oBACV,CAAC;oBAED,QAAQ,GAAG,aAAa,CAAC,QAAQ,CAAC;gBACpC,CAAC;gBAED,IAAI,MAAA,OAAO,CAAC,WAAW,0CAAE,OAAO,EAAE,CAAC;oBACjC,MAAM,CAAC,KAAK,CAAC,SAAS,UAAU,oBAAoB,CAAC,CAAC;oBACtD,MAAM,UAAU,GAAG,IAAI,UAAU,EAAE,CAAC;oBACpC,MAAM,UAAU,CAAC;gBACnB,CAAC;gBAED,IAAI,UAAU,IAAI,CAAC,MAAA,OAAO,CAAC,UAAU,mCAAI,0BAA0B,CAAC,EAAE,CAAC;oBACrE,MAAM,CAAC,IAAI,CACT,SAAS,UAAU,uGAAuG,CAC3H,CAAC;oBACF,IAAI,aAAa,EAAE,CAAC;wBAClB,MAAM,aAAa,CAAC;oBACtB,CAAC;yBAAM,IAAI,QAAQ,EAAE,CAAC;wBACpB,OAAO,QAAQ,CAAC;oBAClB,CAAC;yBAAM,CAAC;wBACN,MAAM,IAAI,KAAK,CAAC,4DAA4D,CAAC,CAAC;oBAChF,CAAC;gBACH,CAAC;gBAED,MAAM,CAAC,IAAI,CAAC,SAAS,UAAU,gBAAgB,UAAU,CAAC,MAAM,oBAAoB,CAAC,CAAC;gBAEtF,cAAc,EAAE,KAAK,MAAM,QAAQ,IAAI,UAAU,EAAE,CAAC;oBAClD,MAAM,cAAc,GAAG,QAAQ,CAAC,MAAM,IAAI,iBAAiB,CAAC;oBAC5D,cAAc,CAAC,IAAI,CAAC,SAAS,UAAU,+BAA+B,QAAQ,CAAC,IAAI,GAAG,CAAC,CAAC;oBAExF,MAAM,SAAS,GAAG,QAAQ,CAAC,KAAK,CAAC;wBAC/B,UAAU;wBACV,QAAQ;wBACR,aAAa;qBACd,CAAC,CAAC;oBAEH,IAAI,SAAS,CAAC,YAAY,EAAE,CAAC;wBAC3B,cAAc,CAAC,IAAI,CAAC,SAAS,UAAU,YAAY,CAAC,CAAC;wBACrD,SAAS,cAAc,CAAC;oBAC1B,CAAC;oBAED,MAAM,EAAE,YAAY,EAAE,cAAc,EAAE,UAAU,EAAE,GAAG,SAAS,CAAC;oBAE/D,IAAI,YAAY,EAAE,CAAC;wBACjB,cAAc,CAAC,KAAK,CAClB,SAAS,UAAU,oBAAoB,QAAQ,CAAC,IAAI,gBAAgB,EACpE,YAAY,CACb,CAAC;wBACF,MAAM,YAAY,CAAC;oBACrB,CAAC;oBAED,IAAI,cAAc,IAAI,cAAc,KAAK,CAAC,EAAE,CAAC;wBAC3C,cAAc,CAAC,IAAI,CACjB,SAAS,UAAU,oBAAoB,QAAQ,CAAC,IAAI,kBAAkB,cAAc,EAAE,CACvF,CAAC;wBACF,MAAM,KAAK,CAAC,cAAc,EAAE,SAAS,EAAE,EAAE,WAAW,EAAE,OAAO,CAAC,WAAW,EAAE,CAAC,CAAC;wBAC7E,SAAS,YAAY,CAAC;oBACxB,CAAC;oBAED,IAAI,UAAU,EAAE,CAAC;wBACf,cAAc,CAAC,IAAI,CACjB,SAAS,UAAU,oBAAoB,QAAQ,CAAC,IAAI,iBAAiB,UAAU,EAAE,CAClF,CAAC;wBACF,OAAO,CAAC,GAAG,GAAG,UAAU,CAAC;wBACzB,SAAS,YAAY,CAAC;oBACxB,CAAC;gBACH,CAAC;gBAED,IAAI,aAAa,EAAE,CAAC;oBAClB,MAAM,CAAC,IAAI,CACT,+EAA+E,CAChF,CAAC;oBACF,MAAM,aAAa,CAAC;gBACtB,CAAC;gBACD,IAAI,QAAQ,EAAE,CAAC;oBACb,MAAM,CAAC,IAAI,CACT,mFAAmF,CACpF,CAAC;oBACF,OAAO,QAAQ,CAAC;gBAClB,CAAC;gBAED,mDAAmD;gBACnD,+DAA+D;gBAC/D,iCAAiC;YACnC,CAAC;QACH,CAAC;KACF,CAAC;AACJ,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport type { PipelineRequest, PipelineResponse, SendRequest } from \"../interfaces.js\";\nimport type { PipelinePolicy } from \"../pipeline.js\";\nimport { delay } from \"../util/helpers.js\";\nimport { type AzureLogger, createClientLogger } from \"@azure/logger\";\nimport type { RetryStrategy } from \"../retryStrategies/retryStrategy.js\";\nimport type { RestError } from \"../restError.js\";\nimport { AbortError } from \"@azure/abort-controller\";\nimport { DEFAULT_RETRY_POLICY_COUNT } from \"../constants.js\";\n\nconst retryPolicyLogger = createClientLogger(\"core-rest-pipeline retryPolicy\");\n\n/**\n * The programmatic identifier of the retryPolicy.\n */\nconst retryPolicyName = \"retryPolicy\";\n\n/**\n * Options to the {@link retryPolicy}\n */\nexport interface RetryPolicyOptions {\n /**\n * Maximum number of retries. If not specified, it will limit to 3 retries.\n */\n maxRetries?: number;\n /**\n * Logger. If it's not provided, a default logger is used.\n */\n logger?: AzureLogger;\n}\n\n/**\n * retryPolicy is a generic policy to enable retrying requests when certain conditions are met\n */\nexport function retryPolicy(\n strategies: RetryStrategy[],\n options: RetryPolicyOptions = { maxRetries: DEFAULT_RETRY_POLICY_COUNT },\n): PipelinePolicy {\n const logger = options.logger || retryPolicyLogger;\n return {\n name: retryPolicyName,\n async sendRequest(request: PipelineRequest, next: SendRequest): Promise {\n let response: PipelineResponse | undefined;\n let responseError: RestError | undefined;\n let retryCount = -1;\n\n // eslint-disable-next-line no-constant-condition\n retryRequest: while (true) {\n retryCount += 1;\n response = undefined;\n responseError = undefined;\n\n try {\n logger.info(`Retry ${retryCount}: Attempting to send request`, request.requestId);\n response = await next(request);\n logger.info(`Retry ${retryCount}: Received a response from request`, request.requestId);\n } catch (e: any) {\n logger.error(`Retry ${retryCount}: Received an error from request`, request.requestId);\n\n // RestErrors are valid targets for the retry strategies.\n // If none of the retry strategies can work with them, they will be thrown later in this policy.\n // If the received error is not a RestError, it is immediately thrown.\n responseError = e as RestError;\n if (!e || responseError.name !== \"RestError\") {\n throw e;\n }\n\n response = responseError.response;\n }\n\n if (request.abortSignal?.aborted) {\n logger.error(`Retry ${retryCount}: Request aborted.`);\n const abortError = new AbortError();\n throw abortError;\n }\n\n if (retryCount >= (options.maxRetries ?? DEFAULT_RETRY_POLICY_COUNT)) {\n logger.info(\n `Retry ${retryCount}: Maximum retries reached. Returning the last received response, or throwing the last received error.`,\n );\n if (responseError) {\n throw responseError;\n } else if (response) {\n return response;\n } else {\n throw new Error(\"Maximum retries reached with no response or error to throw\");\n }\n }\n\n logger.info(`Retry ${retryCount}: Processing ${strategies.length} retry strategies.`);\n\n strategiesLoop: for (const strategy of strategies) {\n const strategyLogger = strategy.logger || retryPolicyLogger;\n strategyLogger.info(`Retry ${retryCount}: Processing retry strategy ${strategy.name}.`);\n\n const modifiers = strategy.retry({\n retryCount,\n response,\n responseError,\n });\n\n if (modifiers.skipStrategy) {\n strategyLogger.info(`Retry ${retryCount}: Skipped.`);\n continue strategiesLoop;\n }\n\n const { errorToThrow, retryAfterInMs, redirectTo } = modifiers;\n\n if (errorToThrow) {\n strategyLogger.error(\n `Retry ${retryCount}: Retry strategy ${strategy.name} throws error:`,\n errorToThrow,\n );\n throw errorToThrow;\n }\n\n if (retryAfterInMs || retryAfterInMs === 0) {\n strategyLogger.info(\n `Retry ${retryCount}: Retry strategy ${strategy.name} retries after ${retryAfterInMs}`,\n );\n await delay(retryAfterInMs, undefined, { abortSignal: request.abortSignal });\n continue retryRequest;\n }\n\n if (redirectTo) {\n strategyLogger.info(\n `Retry ${retryCount}: Retry strategy ${strategy.name} redirects to ${redirectTo}`,\n );\n request.url = redirectTo;\n continue retryRequest;\n }\n }\n\n if (responseError) {\n logger.info(\n `None of the retry strategies could work with the received error. Throwing it.`,\n );\n throw responseError;\n }\n if (response) {\n logger.info(\n `None of the retry strategies could work with the received response. Returning it.`,\n );\n return response;\n }\n\n // If all the retries skip and there's no response,\n // we're still in the retry loop, so a new request will be sent\n // until `maxRetries` is reached.\n }\n },\n };\n}\n"]} \ No newline at end of file +{"version":3,"file":"retryPolicy.js","sourceRoot":"","sources":["../../../src/policies/retryPolicy.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAIlC,OAAO,EAAE,KAAK,EAAE,MAAM,oBAAoB,CAAC;AAC3C,OAAO,EAAoB,kBAAkB,EAAE,MAAM,eAAe,CAAC;AAGrE,OAAO,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAC;AACrD,OAAO,EAAE,0BAA0B,EAAE,MAAM,iBAAiB,CAAC;AAE7D,MAAM,iBAAiB,GAAG,kBAAkB,CAAC,gCAAgC,CAAC,CAAC;AAE/E;;GAEG;AACH,MAAM,eAAe,GAAG,aAAa,CAAC;AAgBtC;;GAEG;AACH,MAAM,UAAU,WAAW,CACzB,UAA2B,EAC3B,UAA8B,EAAE,UAAU,EAAE,0BAA0B,EAAE;IAExE,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,IAAI,iBAAiB,CAAC;IACnD,OAAO;QACL,IAAI,EAAE,eAAe;QACrB,KAAK,CAAC,WAAW,CAAC,OAAwB,EAAE,IAAiB;;YAC3D,IAAI,QAAsC,CAAC;YAC3C,IAAI,aAAoC,CAAC;YACzC,IAAI,UAAU,GAAG,CAAC,CAAC,CAAC;YAEpB,YAAY,EAAE,OAAO,IAAI,EAAE,CAAC;gBAC1B,UAAU,IAAI,CAAC,CAAC;gBAChB,QAAQ,GAAG,SAAS,CAAC;gBACrB,aAAa,GAAG,SAAS,CAAC;gBAE1B,IAAI,CAAC;oBACH,MAAM,CAAC,IAAI,CAAC,SAAS,UAAU,8BAA8B,EAAE,OAAO,CAAC,SAAS,CAAC,CAAC;oBAClF,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,CAAC;oBAC/B,MAAM,CAAC,IAAI,CAAC,SAAS,UAAU,oCAAoC,EAAE,OAAO,CAAC,SAAS,CAAC,CAAC;gBAC1F,CAAC;gBAAC,OAAO,CAAM,EAAE,CAAC;oBAChB,MAAM,CAAC,KAAK,CAAC,SAAS,UAAU,kCAAkC,EAAE,OAAO,CAAC,SAAS,CAAC,CAAC;oBAEvF,yDAAyD;oBACzD,gGAAgG;oBAChG,sEAAsE;oBACtE,aAAa,GAAG,CAAc,CAAC;oBAC/B,IAAI,CAAC,CAAC,IAAI,aAAa,CAAC,IAAI,KAAK,WAAW,EAAE,CAAC;wBAC7C,MAAM,CAAC,CAAC;oBACV,CAAC;oBAED,QAAQ,GAAG,aAAa,CAAC,QAAQ,CAAC;gBACpC,CAAC;gBAED,IAAI,MAAA,OAAO,CAAC,WAAW,0CAAE,OAAO,EAAE,CAAC;oBACjC,MAAM,CAAC,KAAK,CAAC,SAAS,UAAU,oBAAoB,CAAC,CAAC;oBACtD,MAAM,UAAU,GAAG,IAAI,UAAU,EAAE,CAAC;oBACpC,MAAM,UAAU,CAAC;gBACnB,CAAC;gBAED,IAAI,UAAU,IAAI,CAAC,MAAA,OAAO,CAAC,UAAU,mCAAI,0BAA0B,CAAC,EAAE,CAAC;oBACrE,MAAM,CAAC,IAAI,CACT,SAAS,UAAU,uGAAuG,CAC3H,CAAC;oBACF,IAAI,aAAa,EAAE,CAAC;wBAClB,MAAM,aAAa,CAAC;oBACtB,CAAC;yBAAM,IAAI,QAAQ,EAAE,CAAC;wBACpB,OAAO,QAAQ,CAAC;oBAClB,CAAC;yBAAM,CAAC;wBACN,MAAM,IAAI,KAAK,CAAC,4DAA4D,CAAC,CAAC;oBAChF,CAAC;gBACH,CAAC;gBAED,MAAM,CAAC,IAAI,CAAC,SAAS,UAAU,gBAAgB,UAAU,CAAC,MAAM,oBAAoB,CAAC,CAAC;gBAEtF,cAAc,EAAE,KAAK,MAAM,QAAQ,IAAI,UAAU,EAAE,CAAC;oBAClD,MAAM,cAAc,GAAG,QAAQ,CAAC,MAAM,IAAI,iBAAiB,CAAC;oBAC5D,cAAc,CAAC,IAAI,CAAC,SAAS,UAAU,+BAA+B,QAAQ,CAAC,IAAI,GAAG,CAAC,CAAC;oBAExF,MAAM,SAAS,GAAG,QAAQ,CAAC,KAAK,CAAC;wBAC/B,UAAU;wBACV,QAAQ;wBACR,aAAa;qBACd,CAAC,CAAC;oBAEH,IAAI,SAAS,CAAC,YAAY,EAAE,CAAC;wBAC3B,cAAc,CAAC,IAAI,CAAC,SAAS,UAAU,YAAY,CAAC,CAAC;wBACrD,SAAS,cAAc,CAAC;oBAC1B,CAAC;oBAED,MAAM,EAAE,YAAY,EAAE,cAAc,EAAE,UAAU,EAAE,GAAG,SAAS,CAAC;oBAE/D,IAAI,YAAY,EAAE,CAAC;wBACjB,cAAc,CAAC,KAAK,CAClB,SAAS,UAAU,oBAAoB,QAAQ,CAAC,IAAI,gBAAgB,EACpE,YAAY,CACb,CAAC;wBACF,MAAM,YAAY,CAAC;oBACrB,CAAC;oBAED,IAAI,cAAc,IAAI,cAAc,KAAK,CAAC,EAAE,CAAC;wBAC3C,cAAc,CAAC,IAAI,CACjB,SAAS,UAAU,oBAAoB,QAAQ,CAAC,IAAI,kBAAkB,cAAc,EAAE,CACvF,CAAC;wBACF,MAAM,KAAK,CAAC,cAAc,EAAE,SAAS,EAAE,EAAE,WAAW,EAAE,OAAO,CAAC,WAAW,EAAE,CAAC,CAAC;wBAC7E,SAAS,YAAY,CAAC;oBACxB,CAAC;oBAED,IAAI,UAAU,EAAE,CAAC;wBACf,cAAc,CAAC,IAAI,CACjB,SAAS,UAAU,oBAAoB,QAAQ,CAAC,IAAI,iBAAiB,UAAU,EAAE,CAClF,CAAC;wBACF,OAAO,CAAC,GAAG,GAAG,UAAU,CAAC;wBACzB,SAAS,YAAY,CAAC;oBACxB,CAAC;gBACH,CAAC;gBAED,IAAI,aAAa,EAAE,CAAC;oBAClB,MAAM,CAAC,IAAI,CACT,+EAA+E,CAChF,CAAC;oBACF,MAAM,aAAa,CAAC;gBACtB,CAAC;gBACD,IAAI,QAAQ,EAAE,CAAC;oBACb,MAAM,CAAC,IAAI,CACT,mFAAmF,CACpF,CAAC;oBACF,OAAO,QAAQ,CAAC;gBAClB,CAAC;gBAED,mDAAmD;gBACnD,+DAA+D;gBAC/D,iCAAiC;YACnC,CAAC;QACH,CAAC;KACF,CAAC;AACJ,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport type { PipelineRequest, PipelineResponse, SendRequest } from \"../interfaces.js\";\nimport type { PipelinePolicy } from \"../pipeline.js\";\nimport { delay } from \"../util/helpers.js\";\nimport { type AzureLogger, createClientLogger } from \"@azure/logger\";\nimport type { RetryStrategy } from \"../retryStrategies/retryStrategy.js\";\nimport type { RestError } from \"../restError.js\";\nimport { AbortError } from \"@azure/abort-controller\";\nimport { DEFAULT_RETRY_POLICY_COUNT } from \"../constants.js\";\n\nconst retryPolicyLogger = createClientLogger(\"core-rest-pipeline retryPolicy\");\n\n/**\n * The programmatic identifier of the retryPolicy.\n */\nconst retryPolicyName = \"retryPolicy\";\n\n/**\n * Options to the {@link retryPolicy}\n */\nexport interface RetryPolicyOptions {\n /**\n * Maximum number of retries. If not specified, it will limit to 3 retries.\n */\n maxRetries?: number;\n /**\n * Logger. If it's not provided, a default logger is used.\n */\n logger?: AzureLogger;\n}\n\n/**\n * retryPolicy is a generic policy to enable retrying requests when certain conditions are met\n */\nexport function retryPolicy(\n strategies: RetryStrategy[],\n options: RetryPolicyOptions = { maxRetries: DEFAULT_RETRY_POLICY_COUNT },\n): PipelinePolicy {\n const logger = options.logger || retryPolicyLogger;\n return {\n name: retryPolicyName,\n async sendRequest(request: PipelineRequest, next: SendRequest): Promise {\n let response: PipelineResponse | undefined;\n let responseError: RestError | undefined;\n let retryCount = -1;\n\n retryRequest: while (true) {\n retryCount += 1;\n response = undefined;\n responseError = undefined;\n\n try {\n logger.info(`Retry ${retryCount}: Attempting to send request`, request.requestId);\n response = await next(request);\n logger.info(`Retry ${retryCount}: Received a response from request`, request.requestId);\n } catch (e: any) {\n logger.error(`Retry ${retryCount}: Received an error from request`, request.requestId);\n\n // RestErrors are valid targets for the retry strategies.\n // If none of the retry strategies can work with them, they will be thrown later in this policy.\n // If the received error is not a RestError, it is immediately thrown.\n responseError = e as RestError;\n if (!e || responseError.name !== \"RestError\") {\n throw e;\n }\n\n response = responseError.response;\n }\n\n if (request.abortSignal?.aborted) {\n logger.error(`Retry ${retryCount}: Request aborted.`);\n const abortError = new AbortError();\n throw abortError;\n }\n\n if (retryCount >= (options.maxRetries ?? DEFAULT_RETRY_POLICY_COUNT)) {\n logger.info(\n `Retry ${retryCount}: Maximum retries reached. Returning the last received response, or throwing the last received error.`,\n );\n if (responseError) {\n throw responseError;\n } else if (response) {\n return response;\n } else {\n throw new Error(\"Maximum retries reached with no response or error to throw\");\n }\n }\n\n logger.info(`Retry ${retryCount}: Processing ${strategies.length} retry strategies.`);\n\n strategiesLoop: for (const strategy of strategies) {\n const strategyLogger = strategy.logger || retryPolicyLogger;\n strategyLogger.info(`Retry ${retryCount}: Processing retry strategy ${strategy.name}.`);\n\n const modifiers = strategy.retry({\n retryCount,\n response,\n responseError,\n });\n\n if (modifiers.skipStrategy) {\n strategyLogger.info(`Retry ${retryCount}: Skipped.`);\n continue strategiesLoop;\n }\n\n const { errorToThrow, retryAfterInMs, redirectTo } = modifiers;\n\n if (errorToThrow) {\n strategyLogger.error(\n `Retry ${retryCount}: Retry strategy ${strategy.name} throws error:`,\n errorToThrow,\n );\n throw errorToThrow;\n }\n\n if (retryAfterInMs || retryAfterInMs === 0) {\n strategyLogger.info(\n `Retry ${retryCount}: Retry strategy ${strategy.name} retries after ${retryAfterInMs}`,\n );\n await delay(retryAfterInMs, undefined, { abortSignal: request.abortSignal });\n continue retryRequest;\n }\n\n if (redirectTo) {\n strategyLogger.info(\n `Retry ${retryCount}: Retry strategy ${strategy.name} redirects to ${redirectTo}`,\n );\n request.url = redirectTo;\n continue retryRequest;\n }\n }\n\n if (responseError) {\n logger.info(\n `None of the retry strategies could work with the received error. Throwing it.`,\n );\n throw responseError;\n }\n if (response) {\n logger.info(\n `None of the retry strategies could work with the received response. Returning it.`,\n );\n return response;\n }\n\n // If all the retries skip and there's no response,\n // we're still in the retry loop, so a new request will be sent\n // until `maxRetries` is reached.\n }\n },\n };\n}\n"]} \ No newline at end of file diff --git a/node_modules/@azure/core-rest-pipeline/dist/react-native/policies/tracingPolicy.js b/node_modules/@azure/core-rest-pipeline/dist/react-native/policies/tracingPolicy.js index 1be17ec3..455c2561 100644 --- a/node_modules/@azure/core-rest-pipeline/dist/react-native/policies/tracingPolicy.js +++ b/node_modules/@azure/core-rest-pipeline/dist/react-native/policies/tracingPolicy.js @@ -115,9 +115,14 @@ function tryProcessResponse(span, response) { if (serviceRequestId) { span.setAttribute("serviceRequestId", serviceRequestId); } - span.setStatus({ - status: "success", - }); + // Per semantic conventions, only set the status to error if the status code is 4xx or 5xx. + // Otherwise, the status MUST remain unset. + // https://opentelemetry.io/docs/specs/semconv/http/http-spans/#status + if (response.status >= 400) { + span.setStatus({ + status: "error", + }); + } span.end(); } catch (e) { diff --git a/node_modules/@azure/core-rest-pipeline/dist/react-native/policies/tracingPolicy.js.map b/node_modules/@azure/core-rest-pipeline/dist/react-native/policies/tracingPolicy.js.map index e60e964c..b0ced4d4 100644 --- a/node_modules/@azure/core-rest-pipeline/dist/react-native/policies/tracingPolicy.js.map +++ b/node_modules/@azure/core-rest-pipeline/dist/react-native/policies/tracingPolicy.js.map @@ -1 +1 @@ -{"version":3,"file":"tracingPolicy.js","sourceRoot":"","sources":["../../../src/policies/tracingPolicy.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAElC,OAAO,EAIL,mBAAmB,GACpB,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AAG9C,OAAO,EAAE,iBAAiB,EAAE,MAAM,sBAAsB,CAAC;AACzD,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAC;AACnC,OAAO,EAAE,eAAe,EAAE,OAAO,EAAE,MAAM,kBAAkB,CAAC;AAC5D,OAAO,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AAC9C,OAAO,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAC;AAEjD;;GAEG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,eAAe,CAAC;AAmBjD;;;;;GAKG;AACH,MAAM,UAAU,aAAa,CAAC,UAAgC,EAAE;IAC9D,MAAM,gBAAgB,GAAG,iBAAiB,CAAC,OAAO,CAAC,eAAe,CAAC,CAAC;IACpE,MAAM,SAAS,GAAG,IAAI,SAAS,CAAC;QAC9B,gCAAgC,EAAE,OAAO,CAAC,gCAAgC;KAC3E,CAAC,CAAC;IACH,MAAM,aAAa,GAAG,sBAAsB,EAAE,CAAC;IAE/C,OAAO;QACL,IAAI,EAAE,iBAAiB;QACvB,KAAK,CAAC,WAAW,CAAC,OAAwB,EAAE,IAAiB;;YAC3D,IAAI,CAAC,aAAa,EAAE,CAAC;gBACnB,OAAO,IAAI,CAAC,OAAO,CAAC,CAAC;YACvB,CAAC;YAED,MAAM,SAAS,GAAG,MAAM,gBAAgB,CAAC;YAEzC,MAAM,cAAc,GAAG;gBACrB,UAAU,EAAE,SAAS,CAAC,WAAW,CAAC,OAAO,CAAC,GAAG,CAAC;gBAC9C,aAAa,EAAE,OAAO,CAAC,MAAM;gBAC7B,iBAAiB,EAAE,SAAS;gBAC5B,SAAS,EAAE,OAAO,CAAC,SAAS;aAC7B,CAAC;YACF,IAAI,SAAS,EAAE,CAAC;gBACd,cAAc,CAAC,iBAAiB,CAAC,GAAG,SAAS,CAAC;YAChD,CAAC;YAED,MAAM,EAAE,IAAI,EAAE,cAAc,EAAE,GAAG,MAAA,aAAa,CAAC,aAAa,EAAE,OAAO,EAAE,cAAc,CAAC,mCAAI,EAAE,CAAC;YAE7F,IAAI,CAAC,IAAI,IAAI,CAAC,cAAc,EAAE,CAAC;gBAC7B,OAAO,IAAI,CAAC,OAAO,CAAC,CAAC;YACvB,CAAC;YAED,IAAI,CAAC;gBACH,MAAM,QAAQ,GAAG,MAAM,aAAa,CAAC,WAAW,CAAC,cAAc,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;gBAChF,kBAAkB,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;gBACnC,OAAO,QAAQ,CAAC;YAClB,CAAC;YAAC,OAAO,GAAQ,EAAE,CAAC;gBAClB,eAAe,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;gBAC3B,MAAM,GAAG,CAAC;YACZ,CAAC;QACH,CAAC;KACF,CAAC;AACJ,CAAC;AAED,SAAS,sBAAsB;IAC7B,IAAI,CAAC;QACH,OAAO,mBAAmB,CAAC;YACzB,SAAS,EAAE,EAAE;YACb,WAAW,EAAE,2BAA2B;YACxC,cAAc,EAAE,WAAW;SAC5B,CAAC,CAAC;IACL,CAAC;IAAC,OAAO,CAAU,EAAE,CAAC;QACpB,MAAM,CAAC,OAAO,CAAC,0CAA0C,eAAe,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;QAC/E,OAAO,SAAS,CAAC;IACnB,CAAC;AACH,CAAC;AAED,SAAS,aAAa,CACpB,aAA4B,EAC5B,OAAwB,EACxB,cAAuC;IAEvC,IAAI,CAAC;QACH,oFAAoF;QACpF,MAAM,EAAE,IAAI,EAAE,cAAc,EAAE,GAAG,aAAa,CAAC,SAAS,CACtD,QAAQ,OAAO,CAAC,MAAM,EAAE,EACxB,EAAE,cAAc,EAAE,OAAO,CAAC,cAAc,EAAE,EAC1C;YACE,QAAQ,EAAE,QAAQ;YAClB,cAAc;SACf,CACF,CAAC;QAEF,wDAAwD;QACxD,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,EAAE,CAAC;YACxB,IAAI,CAAC,GAAG,EAAE,CAAC;YACX,OAAO,SAAS,CAAC;QACnB,CAAC;QAED,cAAc;QACd,MAAM,OAAO,GAAG,aAAa,CAAC,oBAAoB,CAChD,cAAc,CAAC,cAAc,CAAC,cAAc,CAC7C,CAAC;QACF,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC;YACnD,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;QAClC,CAAC;QACD,OAAO,EAAE,IAAI,EAAE,cAAc,EAAE,cAAc,CAAC,cAAc,CAAC,cAAc,EAAE,CAAC;IAChF,CAAC;IAAC,OAAO,CAAM,EAAE,CAAC;QAChB,MAAM,CAAC,OAAO,CAAC,qDAAqD,eAAe,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;QAC1F,OAAO,SAAS,CAAC;IACnB,CAAC;AACH,CAAC;AAED,SAAS,eAAe,CAAC,IAAiB,EAAE,KAAc;IACxD,IAAI,CAAC;QACH,IAAI,CAAC,SAAS,CAAC;YACb,MAAM,EAAE,OAAO;YACf,KAAK,EAAE,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS;SAC1C,CAAC,CAAC;QACH,IAAI,WAAW,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,UAAU,EAAE,CAAC;YAC3C,IAAI,CAAC,YAAY,CAAC,kBAAkB,EAAE,KAAK,CAAC,UAAU,CAAC,CAAC;QAC1D,CAAC;QACD,IAAI,CAAC,GAAG,EAAE,CAAC;IACb,CAAC;IAAC,OAAO,CAAM,EAAE,CAAC;QAChB,MAAM,CAAC,OAAO,CAAC,qDAAqD,eAAe,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;IAC5F,CAAC;AACH,CAAC;AAED,SAAS,kBAAkB,CAAC,IAAiB,EAAE,QAA0B;IACvE,IAAI,CAAC;QACH,IAAI,CAAC,YAAY,CAAC,kBAAkB,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAC;QACvD,MAAM,gBAAgB,GAAG,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,iBAAiB,CAAC,CAAC;QACjE,IAAI,gBAAgB,EAAE,CAAC;YACrB,IAAI,CAAC,YAAY,CAAC,kBAAkB,EAAE,gBAAgB,CAAC,CAAC;QAC1D,CAAC;QACD,IAAI,CAAC,SAAS,CAAC;YACb,MAAM,EAAE,SAAS;SAClB,CAAC,CAAC;QACH,IAAI,CAAC,GAAG,EAAE,CAAC;IACb,CAAC;IAAC,OAAO,CAAM,EAAE,CAAC;QAChB,MAAM,CAAC,OAAO,CAAC,qDAAqD,eAAe,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;IAC5F,CAAC;AACH,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport {\n type TracingClient,\n type TracingContext,\n type TracingSpan,\n createTracingClient,\n} from \"@azure/core-tracing\";\nimport { SDK_VERSION } from \"../constants.js\";\nimport type { PipelineRequest, PipelineResponse, SendRequest } from \"../interfaces.js\";\nimport type { PipelinePolicy } from \"../pipeline.js\";\nimport { getUserAgentValue } from \"../util/userAgent.js\";\nimport { logger } from \"../log.js\";\nimport { getErrorMessage, isError } from \"@azure/core-util\";\nimport { isRestError } from \"../restError.js\";\nimport { Sanitizer } from \"../util/sanitizer.js\";\n\n/**\n * The programmatic identifier of the tracingPolicy.\n */\nexport const tracingPolicyName = \"tracingPolicy\";\n\n/**\n * Options to configure the tracing policy.\n */\nexport interface TracingPolicyOptions {\n /**\n * String prefix to add to the user agent logged as metadata\n * on the generated Span.\n * Defaults to an empty string.\n */\n userAgentPrefix?: string;\n /**\n * Query string names whose values will be logged when logging is enabled. By default no\n * query string values are logged.\n */\n additionalAllowedQueryParameters?: string[];\n}\n\n/**\n * A simple policy to create OpenTelemetry Spans for each request made by the pipeline\n * that has SpanOptions with a parent.\n * Requests made without a parent Span will not be recorded.\n * @param options - Options to configure the telemetry logged by the tracing policy.\n */\nexport function tracingPolicy(options: TracingPolicyOptions = {}): PipelinePolicy {\n const userAgentPromise = getUserAgentValue(options.userAgentPrefix);\n const sanitizer = new Sanitizer({\n additionalAllowedQueryParameters: options.additionalAllowedQueryParameters,\n });\n const tracingClient = tryCreateTracingClient();\n\n return {\n name: tracingPolicyName,\n async sendRequest(request: PipelineRequest, next: SendRequest): Promise {\n if (!tracingClient) {\n return next(request);\n }\n\n const userAgent = await userAgentPromise;\n\n const spanAttributes = {\n \"http.url\": sanitizer.sanitizeUrl(request.url),\n \"http.method\": request.method,\n \"http.user_agent\": userAgent,\n requestId: request.requestId,\n };\n if (userAgent) {\n spanAttributes[\"http.user_agent\"] = userAgent;\n }\n\n const { span, tracingContext } = tryCreateSpan(tracingClient, request, spanAttributes) ?? {};\n\n if (!span || !tracingContext) {\n return next(request);\n }\n\n try {\n const response = await tracingClient.withContext(tracingContext, next, request);\n tryProcessResponse(span, response);\n return response;\n } catch (err: any) {\n tryProcessError(span, err);\n throw err;\n }\n },\n };\n}\n\nfunction tryCreateTracingClient(): TracingClient | undefined {\n try {\n return createTracingClient({\n namespace: \"\",\n packageName: \"@azure/core-rest-pipeline\",\n packageVersion: SDK_VERSION,\n });\n } catch (e: unknown) {\n logger.warning(`Error when creating the TracingClient: ${getErrorMessage(e)}`);\n return undefined;\n }\n}\n\nfunction tryCreateSpan(\n tracingClient: TracingClient,\n request: PipelineRequest,\n spanAttributes: Record,\n): { span: TracingSpan; tracingContext: TracingContext } | undefined {\n try {\n // As per spec, we do not need to differentiate between HTTP and HTTPS in span name.\n const { span, updatedOptions } = tracingClient.startSpan(\n `HTTP ${request.method}`,\n { tracingOptions: request.tracingOptions },\n {\n spanKind: \"client\",\n spanAttributes,\n },\n );\n\n // If the span is not recording, don't do any more work.\n if (!span.isRecording()) {\n span.end();\n return undefined;\n }\n\n // set headers\n const headers = tracingClient.createRequestHeaders(\n updatedOptions.tracingOptions.tracingContext,\n );\n for (const [key, value] of Object.entries(headers)) {\n request.headers.set(key, value);\n }\n return { span, tracingContext: updatedOptions.tracingOptions.tracingContext };\n } catch (e: any) {\n logger.warning(`Skipping creating a tracing span due to an error: ${getErrorMessage(e)}`);\n return undefined;\n }\n}\n\nfunction tryProcessError(span: TracingSpan, error: unknown): void {\n try {\n span.setStatus({\n status: \"error\",\n error: isError(error) ? error : undefined,\n });\n if (isRestError(error) && error.statusCode) {\n span.setAttribute(\"http.status_code\", error.statusCode);\n }\n span.end();\n } catch (e: any) {\n logger.warning(`Skipping tracing span processing due to an error: ${getErrorMessage(e)}`);\n }\n}\n\nfunction tryProcessResponse(span: TracingSpan, response: PipelineResponse): void {\n try {\n span.setAttribute(\"http.status_code\", response.status);\n const serviceRequestId = response.headers.get(\"x-ms-request-id\");\n if (serviceRequestId) {\n span.setAttribute(\"serviceRequestId\", serviceRequestId);\n }\n span.setStatus({\n status: \"success\",\n });\n span.end();\n } catch (e: any) {\n logger.warning(`Skipping tracing span processing due to an error: ${getErrorMessage(e)}`);\n }\n}\n"]} \ No newline at end of file +{"version":3,"file":"tracingPolicy.js","sourceRoot":"","sources":["../../../src/policies/tracingPolicy.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAElC,OAAO,EAIL,mBAAmB,GACpB,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AAG9C,OAAO,EAAE,iBAAiB,EAAE,MAAM,sBAAsB,CAAC;AACzD,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAC;AACnC,OAAO,EAAE,eAAe,EAAE,OAAO,EAAE,MAAM,kBAAkB,CAAC;AAC5D,OAAO,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AAC9C,OAAO,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAC;AAEjD;;GAEG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,eAAe,CAAC;AAmBjD;;;;;GAKG;AACH,MAAM,UAAU,aAAa,CAAC,UAAgC,EAAE;IAC9D,MAAM,gBAAgB,GAAG,iBAAiB,CAAC,OAAO,CAAC,eAAe,CAAC,CAAC;IACpE,MAAM,SAAS,GAAG,IAAI,SAAS,CAAC;QAC9B,gCAAgC,EAAE,OAAO,CAAC,gCAAgC;KAC3E,CAAC,CAAC;IACH,MAAM,aAAa,GAAG,sBAAsB,EAAE,CAAC;IAE/C,OAAO;QACL,IAAI,EAAE,iBAAiB;QACvB,KAAK,CAAC,WAAW,CAAC,OAAwB,EAAE,IAAiB;;YAC3D,IAAI,CAAC,aAAa,EAAE,CAAC;gBACnB,OAAO,IAAI,CAAC,OAAO,CAAC,CAAC;YACvB,CAAC;YAED,MAAM,SAAS,GAAG,MAAM,gBAAgB,CAAC;YAEzC,MAAM,cAAc,GAAG;gBACrB,UAAU,EAAE,SAAS,CAAC,WAAW,CAAC,OAAO,CAAC,GAAG,CAAC;gBAC9C,aAAa,EAAE,OAAO,CAAC,MAAM;gBAC7B,iBAAiB,EAAE,SAAS;gBAC5B,SAAS,EAAE,OAAO,CAAC,SAAS;aAC7B,CAAC;YACF,IAAI,SAAS,EAAE,CAAC;gBACd,cAAc,CAAC,iBAAiB,CAAC,GAAG,SAAS,CAAC;YAChD,CAAC;YAED,MAAM,EAAE,IAAI,EAAE,cAAc,EAAE,GAAG,MAAA,aAAa,CAAC,aAAa,EAAE,OAAO,EAAE,cAAc,CAAC,mCAAI,EAAE,CAAC;YAE7F,IAAI,CAAC,IAAI,IAAI,CAAC,cAAc,EAAE,CAAC;gBAC7B,OAAO,IAAI,CAAC,OAAO,CAAC,CAAC;YACvB,CAAC;YAED,IAAI,CAAC;gBACH,MAAM,QAAQ,GAAG,MAAM,aAAa,CAAC,WAAW,CAAC,cAAc,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;gBAChF,kBAAkB,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;gBACnC,OAAO,QAAQ,CAAC;YAClB,CAAC;YAAC,OAAO,GAAQ,EAAE,CAAC;gBAClB,eAAe,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;gBAC3B,MAAM,GAAG,CAAC;YACZ,CAAC;QACH,CAAC;KACF,CAAC;AACJ,CAAC;AAED,SAAS,sBAAsB;IAC7B,IAAI,CAAC;QACH,OAAO,mBAAmB,CAAC;YACzB,SAAS,EAAE,EAAE;YACb,WAAW,EAAE,2BAA2B;YACxC,cAAc,EAAE,WAAW;SAC5B,CAAC,CAAC;IACL,CAAC;IAAC,OAAO,CAAU,EAAE,CAAC;QACpB,MAAM,CAAC,OAAO,CAAC,0CAA0C,eAAe,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;QAC/E,OAAO,SAAS,CAAC;IACnB,CAAC;AACH,CAAC;AAED,SAAS,aAAa,CACpB,aAA4B,EAC5B,OAAwB,EACxB,cAAuC;IAEvC,IAAI,CAAC;QACH,oFAAoF;QACpF,MAAM,EAAE,IAAI,EAAE,cAAc,EAAE,GAAG,aAAa,CAAC,SAAS,CACtD,QAAQ,OAAO,CAAC,MAAM,EAAE,EACxB,EAAE,cAAc,EAAE,OAAO,CAAC,cAAc,EAAE,EAC1C;YACE,QAAQ,EAAE,QAAQ;YAClB,cAAc;SACf,CACF,CAAC;QAEF,wDAAwD;QACxD,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,EAAE,CAAC;YACxB,IAAI,CAAC,GAAG,EAAE,CAAC;YACX,OAAO,SAAS,CAAC;QACnB,CAAC;QAED,cAAc;QACd,MAAM,OAAO,GAAG,aAAa,CAAC,oBAAoB,CAChD,cAAc,CAAC,cAAc,CAAC,cAAc,CAC7C,CAAC;QACF,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC;YACnD,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;QAClC,CAAC;QACD,OAAO,EAAE,IAAI,EAAE,cAAc,EAAE,cAAc,CAAC,cAAc,CAAC,cAAc,EAAE,CAAC;IAChF,CAAC;IAAC,OAAO,CAAM,EAAE,CAAC;QAChB,MAAM,CAAC,OAAO,CAAC,qDAAqD,eAAe,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;QAC1F,OAAO,SAAS,CAAC;IACnB,CAAC;AACH,CAAC;AAED,SAAS,eAAe,CAAC,IAAiB,EAAE,KAAc;IACxD,IAAI,CAAC;QACH,IAAI,CAAC,SAAS,CAAC;YACb,MAAM,EAAE,OAAO;YACf,KAAK,EAAE,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS;SAC1C,CAAC,CAAC;QACH,IAAI,WAAW,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,UAAU,EAAE,CAAC;YAC3C,IAAI,CAAC,YAAY,CAAC,kBAAkB,EAAE,KAAK,CAAC,UAAU,CAAC,CAAC;QAC1D,CAAC;QACD,IAAI,CAAC,GAAG,EAAE,CAAC;IACb,CAAC;IAAC,OAAO,CAAM,EAAE,CAAC;QAChB,MAAM,CAAC,OAAO,CAAC,qDAAqD,eAAe,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;IAC5F,CAAC;AACH,CAAC;AAED,SAAS,kBAAkB,CAAC,IAAiB,EAAE,QAA0B;IACvE,IAAI,CAAC;QACH,IAAI,CAAC,YAAY,CAAC,kBAAkB,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAC;QACvD,MAAM,gBAAgB,GAAG,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,iBAAiB,CAAC,CAAC;QACjE,IAAI,gBAAgB,EAAE,CAAC;YACrB,IAAI,CAAC,YAAY,CAAC,kBAAkB,EAAE,gBAAgB,CAAC,CAAC;QAC1D,CAAC;QACD,2FAA2F;QAC3F,2CAA2C;QAC3C,sEAAsE;QACtE,IAAI,QAAQ,CAAC,MAAM,IAAI,GAAG,EAAE,CAAC;YAC3B,IAAI,CAAC,SAAS,CAAC;gBACb,MAAM,EAAE,OAAO;aAChB,CAAC,CAAC;QACL,CAAC;QACD,IAAI,CAAC,GAAG,EAAE,CAAC;IACb,CAAC;IAAC,OAAO,CAAM,EAAE,CAAC;QAChB,MAAM,CAAC,OAAO,CAAC,qDAAqD,eAAe,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;IAC5F,CAAC;AACH,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport {\n type TracingClient,\n type TracingContext,\n type TracingSpan,\n createTracingClient,\n} from \"@azure/core-tracing\";\nimport { SDK_VERSION } from \"../constants.js\";\nimport type { PipelineRequest, PipelineResponse, SendRequest } from \"../interfaces.js\";\nimport type { PipelinePolicy } from \"../pipeline.js\";\nimport { getUserAgentValue } from \"../util/userAgent.js\";\nimport { logger } from \"../log.js\";\nimport { getErrorMessage, isError } from \"@azure/core-util\";\nimport { isRestError } from \"../restError.js\";\nimport { Sanitizer } from \"../util/sanitizer.js\";\n\n/**\n * The programmatic identifier of the tracingPolicy.\n */\nexport const tracingPolicyName = \"tracingPolicy\";\n\n/**\n * Options to configure the tracing policy.\n */\nexport interface TracingPolicyOptions {\n /**\n * String prefix to add to the user agent logged as metadata\n * on the generated Span.\n * Defaults to an empty string.\n */\n userAgentPrefix?: string;\n /**\n * Query string names whose values will be logged when logging is enabled. By default no\n * query string values are logged.\n */\n additionalAllowedQueryParameters?: string[];\n}\n\n/**\n * A simple policy to create OpenTelemetry Spans for each request made by the pipeline\n * that has SpanOptions with a parent.\n * Requests made without a parent Span will not be recorded.\n * @param options - Options to configure the telemetry logged by the tracing policy.\n */\nexport function tracingPolicy(options: TracingPolicyOptions = {}): PipelinePolicy {\n const userAgentPromise = getUserAgentValue(options.userAgentPrefix);\n const sanitizer = new Sanitizer({\n additionalAllowedQueryParameters: options.additionalAllowedQueryParameters,\n });\n const tracingClient = tryCreateTracingClient();\n\n return {\n name: tracingPolicyName,\n async sendRequest(request: PipelineRequest, next: SendRequest): Promise {\n if (!tracingClient) {\n return next(request);\n }\n\n const userAgent = await userAgentPromise;\n\n const spanAttributes = {\n \"http.url\": sanitizer.sanitizeUrl(request.url),\n \"http.method\": request.method,\n \"http.user_agent\": userAgent,\n requestId: request.requestId,\n };\n if (userAgent) {\n spanAttributes[\"http.user_agent\"] = userAgent;\n }\n\n const { span, tracingContext } = tryCreateSpan(tracingClient, request, spanAttributes) ?? {};\n\n if (!span || !tracingContext) {\n return next(request);\n }\n\n try {\n const response = await tracingClient.withContext(tracingContext, next, request);\n tryProcessResponse(span, response);\n return response;\n } catch (err: any) {\n tryProcessError(span, err);\n throw err;\n }\n },\n };\n}\n\nfunction tryCreateTracingClient(): TracingClient | undefined {\n try {\n return createTracingClient({\n namespace: \"\",\n packageName: \"@azure/core-rest-pipeline\",\n packageVersion: SDK_VERSION,\n });\n } catch (e: unknown) {\n logger.warning(`Error when creating the TracingClient: ${getErrorMessage(e)}`);\n return undefined;\n }\n}\n\nfunction tryCreateSpan(\n tracingClient: TracingClient,\n request: PipelineRequest,\n spanAttributes: Record,\n): { span: TracingSpan; tracingContext: TracingContext } | undefined {\n try {\n // As per spec, we do not need to differentiate between HTTP and HTTPS in span name.\n const { span, updatedOptions } = tracingClient.startSpan(\n `HTTP ${request.method}`,\n { tracingOptions: request.tracingOptions },\n {\n spanKind: \"client\",\n spanAttributes,\n },\n );\n\n // If the span is not recording, don't do any more work.\n if (!span.isRecording()) {\n span.end();\n return undefined;\n }\n\n // set headers\n const headers = tracingClient.createRequestHeaders(\n updatedOptions.tracingOptions.tracingContext,\n );\n for (const [key, value] of Object.entries(headers)) {\n request.headers.set(key, value);\n }\n return { span, tracingContext: updatedOptions.tracingOptions.tracingContext };\n } catch (e: any) {\n logger.warning(`Skipping creating a tracing span due to an error: ${getErrorMessage(e)}`);\n return undefined;\n }\n}\n\nfunction tryProcessError(span: TracingSpan, error: unknown): void {\n try {\n span.setStatus({\n status: \"error\",\n error: isError(error) ? error : undefined,\n });\n if (isRestError(error) && error.statusCode) {\n span.setAttribute(\"http.status_code\", error.statusCode);\n }\n span.end();\n } catch (e: any) {\n logger.warning(`Skipping tracing span processing due to an error: ${getErrorMessage(e)}`);\n }\n}\n\nfunction tryProcessResponse(span: TracingSpan, response: PipelineResponse): void {\n try {\n span.setAttribute(\"http.status_code\", response.status);\n const serviceRequestId = response.headers.get(\"x-ms-request-id\");\n if (serviceRequestId) {\n span.setAttribute(\"serviceRequestId\", serviceRequestId);\n }\n // Per semantic conventions, only set the status to error if the status code is 4xx or 5xx.\n // Otherwise, the status MUST remain unset.\n // https://opentelemetry.io/docs/specs/semconv/http/http-spans/#status\n if (response.status >= 400) {\n span.setStatus({\n status: \"error\",\n });\n }\n span.end();\n } catch (e: any) {\n logger.warning(`Skipping tracing span processing due to an error: ${getErrorMessage(e)}`);\n }\n}\n"]} \ No newline at end of file diff --git a/node_modules/@azure/core-rest-pipeline/dist/react-native/restError.d.ts b/node_modules/@azure/core-rest-pipeline/dist/react-native/restError.d.ts index 0bb2fc48..66264448 100644 --- a/node_modules/@azure/core-rest-pipeline/dist/react-native/restError.d.ts +++ b/node_modules/@azure/core-rest-pipeline/dist/react-native/restError.d.ts @@ -24,6 +24,7 @@ export interface RestErrorOptions { * A custom error type for failed pipeline requests. */ export declare class RestError extends Error { + [x: symbol]: () => string; /** * Something went wrong when making the request. * This means the actual request failed for some reason, diff --git a/node_modules/@azure/core-rest-pipeline/dist/react-native/restError.d.ts.map b/node_modules/@azure/core-rest-pipeline/dist/react-native/restError.d.ts.map index d6e29e6c..a10965e3 100644 --- a/node_modules/@azure/core-rest-pipeline/dist/react-native/restError.d.ts.map +++ b/node_modules/@azure/core-rest-pipeline/dist/react-native/restError.d.ts.map @@ -1 +1 @@ -{"version":3,"file":"restError.d.ts","sourceRoot":"","sources":["../../src/restError.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,eAAe,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAC;AAMzE;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,OAAO,CAAC,EAAE,eAAe,CAAC;IAC1B;;OAEG;IACH,QAAQ,CAAC,EAAE,gBAAgB,CAAC;CAC7B;AAED;;GAEG;AACH,qBAAa,SAAU,SAAQ,KAAK;IAClC;;;;OAIG;IACH,MAAM,CAAC,QAAQ,CAAC,kBAAkB,EAAE,MAAM,CAAwB;IAClE;;;OAGG;IACH,MAAM,CAAC,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAiB;IAEpD;;OAEG;IACI,IAAI,CAAC,EAAE,MAAM,CAAC;IACrB;;OAEG;IACI,UAAU,CAAC,EAAE,MAAM,CAAC;IAC3B;;;OAGG;IACI,OAAO,CAAC,EAAE,eAAe,CAAC;IACjC;;;OAGG;IACI,QAAQ,CAAC,EAAE,gBAAgB,CAAC;IACnC;;OAEG;IACI,OAAO,CAAC,EAAE,OAAO,CAAC;gBAEb,OAAO,EAAE,MAAM,EAAE,OAAO,GAAE,gBAAqB;CA4B5D;AAED;;;GAGG;AACH,wBAAgB,WAAW,CAAC,CAAC,EAAE,OAAO,GAAG,CAAC,IAAI,SAAS,CAKtD"} \ No newline at end of file +{"version":3,"file":"restError.d.ts","sourceRoot":"","sources":["../../src/restError.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,eAAe,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAC;AAMzE;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,OAAO,CAAC,EAAE,eAAe,CAAC;IAC1B;;OAEG;IACH,QAAQ,CAAC,EAAE,gBAAgB,CAAC;CAC7B;AAED;;GAEG;AACH,qBAAa,SAAU,SAAQ,KAAK;uBAuDtB,MAAM;IAtDlB;;;;OAIG;IACH,MAAM,CAAC,QAAQ,CAAC,kBAAkB,EAAE,MAAM,CAAwB;IAClE;;;OAGG;IACH,MAAM,CAAC,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAiB;IAEpD;;OAEG;IACI,IAAI,CAAC,EAAE,MAAM,CAAC;IACrB;;OAEG;IACI,UAAU,CAAC,EAAE,MAAM,CAAC;IAC3B;;;OAGG;IACI,OAAO,CAAC,EAAE,eAAe,CAAC;IACjC;;;OAGG;IACI,QAAQ,CAAC,EAAE,gBAAgB,CAAC;IACnC;;OAEG;IACI,OAAO,CAAC,EAAE,OAAO,CAAC;gBAEb,OAAO,EAAE,MAAM,EAAE,OAAO,GAAE,gBAAqB;CA4B5D;AAED;;;GAGG;AACH,wBAAgB,WAAW,CAAC,CAAC,EAAE,OAAO,GAAG,CAAC,IAAI,SAAS,CAKtD"} \ No newline at end of file diff --git a/node_modules/@azure/core-rest-pipeline/dist/react-native/util/file.d.ts.map b/node_modules/@azure/core-rest-pipeline/dist/react-native/util/file.d.ts.map index 092797aa..d165dbda 100644 --- a/node_modules/@azure/core-rest-pipeline/dist/react-native/util/file.d.ts.map +++ b/node_modules/@azure/core-rest-pipeline/dist/react-native/util/file.d.ts.map @@ -1 +1 @@ -{"version":3,"file":"file.d.ts","sourceRoot":"","sources":["../../../src/util/file.ts"],"names":[],"mappings":"AAMA;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAC7B;AAED;;GAEG;AACH,MAAM,WAAW,2BAA4B,SAAQ,iBAAiB;IACpE;;;;;OAKG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAyCD;;;;;;GAMG;AACH,wBAAgB,aAAa,CAC3B,IAAI,EAAE,IAAI,GACT,MAAM,CAAC,cAAc,GAAG,cAAc,CAAC,UAAU,CAAC,GAAG,UAAU,CAMjE;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,oBAAoB,CAClC,MAAM,EAAE,MAAM,cAAc,CAAC,UAAU,CAAC,GAAG,MAAM,CAAC,cAAc,EAChE,IAAI,EAAE,MAAM,EACZ,OAAO,GAAE,2BAAgC,GACxC,IAAI,CAoBN;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,UAAU,CACxB,OAAO,EAAE,UAAU,EACnB,IAAI,EAAE,MAAM,EACZ,OAAO,GAAE,iBAAsB,GAC9B,IAAI,CAgBN"} \ No newline at end of file +{"version":3,"file":"file.d.ts","sourceRoot":"","sources":["../../../src/util/file.ts"],"names":[],"mappings":"AAMA;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAC7B;AAED;;GAEG;AACH,MAAM,WAAW,2BAA4B,SAAQ,iBAAiB;IACpE;;;;;OAKG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AA4CD;;;;;;GAMG;AACH,wBAAgB,aAAa,CAC3B,IAAI,EAAE,IAAI,GACT,MAAM,CAAC,cAAc,GAAG,cAAc,CAAC,UAAU,CAAC,GAAG,UAAU,CAMjE;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,oBAAoB,CAClC,MAAM,EAAE,MAAM,cAAc,CAAC,UAAU,CAAC,GAAG,MAAM,CAAC,cAAc,EAChE,IAAI,EAAE,MAAM,EACZ,OAAO,GAAE,2BAAgC,GACxC,IAAI,CAoBN;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,UAAU,CACxB,OAAO,EAAE,UAAU,EACnB,IAAI,EAAE,MAAM,EACZ,OAAO,GAAE,iBAAsB,GAC9B,IAAI,CAgBN"} \ No newline at end of file diff --git a/node_modules/@azure/core-rest-pipeline/dist/react-native/util/file.js b/node_modules/@azure/core-rest-pipeline/dist/react-native/util/file.js index a9af2dc5..0a26caa1 100644 --- a/node_modules/@azure/core-rest-pipeline/dist/react-native/util/file.js +++ b/node_modules/@azure/core-rest-pipeline/dist/react-native/util/file.js @@ -6,6 +6,9 @@ const unimplementedMethods = { arrayBuffer: () => { throw new Error("Not implemented"); }, + bytes: () => { + throw new Error("Not implemented"); + }, slice: () => { throw new Error("Not implemented"); }, diff --git a/node_modules/@azure/core-rest-pipeline/dist/react-native/util/file.js.map b/node_modules/@azure/core-rest-pipeline/dist/react-native/util/file.js.map index 87721d1a..05a0c7da 100644 --- a/node_modules/@azure/core-rest-pipeline/dist/react-native/util/file.js.map +++ b/node_modules/@azure/core-rest-pipeline/dist/react-native/util/file.js.map @@ -1 +1 @@ -{"version":3,"file":"file.js","sourceRoot":"","sources":["../../../src/util/file.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAElC,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAC9C,OAAO,EAAE,oBAAoB,EAAE,MAAM,iBAAiB,CAAC;AAoCvD,MAAM,oBAAoB,GAAG;IAC3B,WAAW,EAAE,GAAG,EAAE;QAChB,MAAM,IAAI,KAAK,CAAC,iBAAiB,CAAC,CAAC;IACrC,CAAC;IACD,KAAK,EAAE,GAAG,EAAE;QACV,MAAM,IAAI,KAAK,CAAC,iBAAiB,CAAC,CAAC;IACrC,CAAC;IACD,IAAI,EAAE,GAAG,EAAE;QACT,MAAM,IAAI,KAAK,CAAC,iBAAiB,CAAC,CAAC;IACrC,CAAC;CACF,CAAC;AAEF;;;;;;;;;;;;;GAaG;AACH,MAAM,UAAU,GAAkB,MAAM,CAAC,YAAY,CAAC,CAAC;AASvD,SAAS,aAAa,CAAC,CAAU;IAC/B,OAAO,OAAQ,CAAgB,CAAC,UAAU,CAAC,KAAK,UAAU,CAAC;AAC7D,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,aAAa,CAC3B,IAAU;IAEV,IAAI,aAAa,CAAC,IAAI,CAAC,EAAE,CAAC;QACxB,OAAO,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC;IAC5B,CAAC;SAAM,CAAC;QACN,OAAO,IAAI,CAAC,MAAM,EAAE,CAAC;IACvB,CAAC;AACH,CAAC;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,UAAU,oBAAoB,CAClC,MAAgE,EAChE,IAAY,EACZ,UAAuC,EAAE;;IAEzC,OAAO,gCACF,oBAAoB,KACvB,IAAI,EAAE,MAAA,OAAO,CAAC,IAAI,mCAAI,EAAE,EACxB,YAAY,EAAE,MAAA,OAAO,CAAC,YAAY,mCAAI,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,EAC1D,kBAAkB,EAAE,MAAA,OAAO,CAAC,kBAAkB,mCAAI,EAAE,EACpD,IAAI,EAAE,MAAA,OAAO,CAAC,IAAI,mCAAI,CAAC,CAAC,EACxB,IAAI,EACJ,MAAM,EAAE,GAAG,EAAE;YACX,MAAM,CAAC,GAAG,MAAM,EAAE,CAAC;YACnB,IAAI,oBAAoB,CAAC,CAAC,CAAC,EAAE,CAAC;gBAC5B,MAAM,IAAI,KAAK,CACb,6EAA6E,CAC9E,CAAC;YACJ,CAAC;YAED,OAAO,CAAC,CAAC;QACX,CAAC,EACD,CAAC,UAAU,CAAC,EAAE,MAAM,GACA,CAAC;AACzB,CAAC;AAED;;;;;;;;;;GAUG;AACH,MAAM,UAAU,UAAU,CACxB,OAAmB,EACnB,IAAY,EACZ,UAA6B,EAAE;;IAE/B,IAAI,UAAU,EAAE,CAAC;QACf,OAAO,gCACF,oBAAoB,KACvB,IAAI,EAAE,MAAA,OAAO,CAAC,IAAI,mCAAI,EAAE,EACxB,YAAY,EAAE,MAAA,OAAO,CAAC,YAAY,mCAAI,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,EAC1D,kBAAkB,EAAE,MAAA,OAAO,CAAC,kBAAkB,mCAAI,EAAE,EACpD,IAAI,EAAE,OAAO,CAAC,UAAU,EACxB,IAAI,EACJ,WAAW,EAAE,KAAK,IAAI,EAAE,CAAC,OAAO,CAAC,MAAM,EACvC,MAAM,EAAE,GAAG,EAAE,CAAC,IAAI,IAAI,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,EAAE,EAC1C,CAAC,UAAU,CAAC,EAAE,GAAG,EAAE,CAAC,OAAO,GACP,CAAC;IACzB,CAAC;SAAM,CAAC;QACN,OAAO,IAAI,IAAI,CAAC,CAAC,OAAO,CAAC,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;IAC5C,CAAC;AACH,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport { isNodeLike } from \"@azure/core-util\";\nimport { isNodeReadableStream } from \"./typeGuards.js\";\n\n/**\n * Options passed into createFile specifying metadata about the file.\n */\nexport interface CreateFileOptions {\n /**\n * The MIME type of the file.\n */\n type?: string;\n\n /**\n * Last modified time of the file as a UNIX timestamp.\n * This will default to the current date.\n */\n lastModified?: number;\n\n /**\n * relative path of this file when uploading a directory.\n */\n webkitRelativePath?: string;\n}\n\n/**\n * Extra options for createFile when a stream is being passed in.\n */\nexport interface CreateFileFromStreamOptions extends CreateFileOptions {\n /**\n * Size of the file represented by the stream in bytes.\n *\n * This will be used by the pipeline when calculating the Content-Length header\n * for the overall request.\n */\n size?: number;\n}\n\nconst unimplementedMethods = {\n arrayBuffer: () => {\n throw new Error(\"Not implemented\");\n },\n slice: () => {\n throw new Error(\"Not implemented\");\n },\n text: () => {\n throw new Error(\"Not implemented\");\n },\n};\n\n/**\n * Private symbol used as key on objects created using createFile containing the\n * original source of the file object.\n *\n * This is used in Node to access the original Node stream without using Blob#stream, which\n * returns a web stream. This is done to avoid a couple of bugs to do with Blob#stream and\n * Readable#to/fromWeb in Node versions we support:\n * - https://github.com/nodejs/node/issues/42694 (fixed in Node 18.14)\n * - https://github.com/nodejs/node/issues/48916 (fixed in Node 20.6)\n *\n * Once these versions are no longer supported, we may be able to stop doing this.\n *\n * @internal\n */\nconst rawContent: unique symbol = Symbol(\"rawContent\");\n\n/**\n * Type signature of a blob-like object with a raw content property.\n */\ninterface RawContent {\n [rawContent](): Uint8Array | NodeJS.ReadableStream | ReadableStream;\n}\n\nfunction hasRawContent(x: unknown): x is RawContent {\n return typeof (x as RawContent)[rawContent] === \"function\";\n}\n\n/**\n * Extract the raw content from a given blob-like object. If the input was created using createFile\n * or createFileFromStream, the exact content passed into createFile/createFileFromStream will be used.\n * For true instances of Blob and File, returns the blob's content as a Web ReadableStream.\n *\n * @internal\n */\nexport function getRawContent(\n blob: Blob,\n): NodeJS.ReadableStream | ReadableStream | Uint8Array {\n if (hasRawContent(blob)) {\n return blob[rawContent]();\n } else {\n return blob.stream();\n }\n}\n\n/**\n * Create an object that implements the File interface. This object is intended to be\n * passed into RequestBodyType.formData, and is not guaranteed to work as expected in\n * other situations.\n *\n * Use this function to:\n * - Create a File object for use in RequestBodyType.formData in environments where the\n * global File object is unavailable.\n * - Create a File-like object from a readable stream without reading the stream into memory.\n *\n * @param stream - the content of the file as a callback returning a stream. When a File object made using createFile is\n * passed in a request's form data map, the stream will not be read into memory\n * and instead will be streamed when the request is made. In the event of a retry, the\n * stream needs to be read again, so this callback SHOULD return a fresh stream if possible.\n * @param name - the name of the file.\n * @param options - optional metadata about the file, e.g. file name, file size, MIME type.\n */\nexport function createFileFromStream(\n stream: () => ReadableStream | NodeJS.ReadableStream,\n name: string,\n options: CreateFileFromStreamOptions = {},\n): File {\n return {\n ...unimplementedMethods,\n type: options.type ?? \"\",\n lastModified: options.lastModified ?? new Date().getTime(),\n webkitRelativePath: options.webkitRelativePath ?? \"\",\n size: options.size ?? -1,\n name,\n stream: () => {\n const s = stream();\n if (isNodeReadableStream(s)) {\n throw new Error(\n \"Not supported: a Node stream was provided as input to createFileFromStream.\",\n );\n }\n\n return s;\n },\n [rawContent]: stream,\n } as File & RawContent;\n}\n\n/**\n * Create an object that implements the File interface. This object is intended to be\n * passed into RequestBodyType.formData, and is not guaranteed to work as expected in\n * other situations.\n *\n * Use this function create a File object for use in RequestBodyType.formData in environments where the global File object is unavailable.\n *\n * @param content - the content of the file as a Uint8Array in memory.\n * @param name - the name of the file.\n * @param options - optional metadata about the file, e.g. file name, file size, MIME type.\n */\nexport function createFile(\n content: Uint8Array,\n name: string,\n options: CreateFileOptions = {},\n): File {\n if (isNodeLike) {\n return {\n ...unimplementedMethods,\n type: options.type ?? \"\",\n lastModified: options.lastModified ?? new Date().getTime(),\n webkitRelativePath: options.webkitRelativePath ?? \"\",\n size: content.byteLength,\n name,\n arrayBuffer: async () => content.buffer,\n stream: () => new Blob([content]).stream(),\n [rawContent]: () => content,\n } as File & RawContent;\n } else {\n return new File([content], name, options);\n }\n}\n"]} \ No newline at end of file +{"version":3,"file":"file.js","sourceRoot":"","sources":["../../../src/util/file.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAElC,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAC9C,OAAO,EAAE,oBAAoB,EAAE,MAAM,iBAAiB,CAAC;AAoCvD,MAAM,oBAAoB,GAAG;IAC3B,WAAW,EAAE,GAAG,EAAE;QAChB,MAAM,IAAI,KAAK,CAAC,iBAAiB,CAAC,CAAC;IACrC,CAAC;IACD,KAAK,EAAE,GAAG,EAAE;QACV,MAAM,IAAI,KAAK,CAAC,iBAAiB,CAAC,CAAC;IACrC,CAAC;IACD,KAAK,EAAE,GAAG,EAAE;QACV,MAAM,IAAI,KAAK,CAAC,iBAAiB,CAAC,CAAC;IACrC,CAAC;IACD,IAAI,EAAE,GAAG,EAAE;QACT,MAAM,IAAI,KAAK,CAAC,iBAAiB,CAAC,CAAC;IACrC,CAAC;CACF,CAAC;AAEF;;;;;;;;;;;;;GAaG;AACH,MAAM,UAAU,GAAkB,MAAM,CAAC,YAAY,CAAC,CAAC;AASvD,SAAS,aAAa,CAAC,CAAU;IAC/B,OAAO,OAAQ,CAAgB,CAAC,UAAU,CAAC,KAAK,UAAU,CAAC;AAC7D,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,aAAa,CAC3B,IAAU;IAEV,IAAI,aAAa,CAAC,IAAI,CAAC,EAAE,CAAC;QACxB,OAAO,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC;IAC5B,CAAC;SAAM,CAAC;QACN,OAAO,IAAI,CAAC,MAAM,EAAE,CAAC;IACvB,CAAC;AACH,CAAC;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,UAAU,oBAAoB,CAClC,MAAgE,EAChE,IAAY,EACZ,UAAuC,EAAE;;IAEzC,OAAO,gCACF,oBAAoB,KACvB,IAAI,EAAE,MAAA,OAAO,CAAC,IAAI,mCAAI,EAAE,EACxB,YAAY,EAAE,MAAA,OAAO,CAAC,YAAY,mCAAI,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,EAC1D,kBAAkB,EAAE,MAAA,OAAO,CAAC,kBAAkB,mCAAI,EAAE,EACpD,IAAI,EAAE,MAAA,OAAO,CAAC,IAAI,mCAAI,CAAC,CAAC,EACxB,IAAI,EACJ,MAAM,EAAE,GAAG,EAAE;YACX,MAAM,CAAC,GAAG,MAAM,EAAE,CAAC;YACnB,IAAI,oBAAoB,CAAC,CAAC,CAAC,EAAE,CAAC;gBAC5B,MAAM,IAAI,KAAK,CACb,6EAA6E,CAC9E,CAAC;YACJ,CAAC;YAED,OAAO,CAAC,CAAC;QACX,CAAC,EACD,CAAC,UAAU,CAAC,EAAE,MAAM,GACA,CAAC;AACzB,CAAC;AAED;;;;;;;;;;GAUG;AACH,MAAM,UAAU,UAAU,CACxB,OAAmB,EACnB,IAAY,EACZ,UAA6B,EAAE;;IAE/B,IAAI,UAAU,EAAE,CAAC;QACf,OAAO,gCACF,oBAAoB,KACvB,IAAI,EAAE,MAAA,OAAO,CAAC,IAAI,mCAAI,EAAE,EACxB,YAAY,EAAE,MAAA,OAAO,CAAC,YAAY,mCAAI,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,EAC1D,kBAAkB,EAAE,MAAA,OAAO,CAAC,kBAAkB,mCAAI,EAAE,EACpD,IAAI,EAAE,OAAO,CAAC,UAAU,EACxB,IAAI,EACJ,WAAW,EAAE,KAAK,IAAI,EAAE,CAAC,OAAO,CAAC,MAAM,EACvC,MAAM,EAAE,GAAG,EAAE,CAAC,IAAI,IAAI,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,EAAE,EAC1C,CAAC,UAAU,CAAC,EAAE,GAAG,EAAE,CAAC,OAAO,GACP,CAAC;IACzB,CAAC;SAAM,CAAC;QACN,OAAO,IAAI,IAAI,CAAC,CAAC,OAAO,CAAC,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;IAC5C,CAAC;AACH,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport { isNodeLike } from \"@azure/core-util\";\nimport { isNodeReadableStream } from \"./typeGuards.js\";\n\n/**\n * Options passed into createFile specifying metadata about the file.\n */\nexport interface CreateFileOptions {\n /**\n * The MIME type of the file.\n */\n type?: string;\n\n /**\n * Last modified time of the file as a UNIX timestamp.\n * This will default to the current date.\n */\n lastModified?: number;\n\n /**\n * relative path of this file when uploading a directory.\n */\n webkitRelativePath?: string;\n}\n\n/**\n * Extra options for createFile when a stream is being passed in.\n */\nexport interface CreateFileFromStreamOptions extends CreateFileOptions {\n /**\n * Size of the file represented by the stream in bytes.\n *\n * This will be used by the pipeline when calculating the Content-Length header\n * for the overall request.\n */\n size?: number;\n}\n\nconst unimplementedMethods = {\n arrayBuffer: () => {\n throw new Error(\"Not implemented\");\n },\n bytes: () => {\n throw new Error(\"Not implemented\");\n },\n slice: () => {\n throw new Error(\"Not implemented\");\n },\n text: () => {\n throw new Error(\"Not implemented\");\n },\n};\n\n/**\n * Private symbol used as key on objects created using createFile containing the\n * original source of the file object.\n *\n * This is used in Node to access the original Node stream without using Blob#stream, which\n * returns a web stream. This is done to avoid a couple of bugs to do with Blob#stream and\n * Readable#to/fromWeb in Node versions we support:\n * - https://github.com/nodejs/node/issues/42694 (fixed in Node 18.14)\n * - https://github.com/nodejs/node/issues/48916 (fixed in Node 20.6)\n *\n * Once these versions are no longer supported, we may be able to stop doing this.\n *\n * @internal\n */\nconst rawContent: unique symbol = Symbol(\"rawContent\");\n\n/**\n * Type signature of a blob-like object with a raw content property.\n */\ninterface RawContent {\n [rawContent](): Uint8Array | NodeJS.ReadableStream | ReadableStream;\n}\n\nfunction hasRawContent(x: unknown): x is RawContent {\n return typeof (x as RawContent)[rawContent] === \"function\";\n}\n\n/**\n * Extract the raw content from a given blob-like object. If the input was created using createFile\n * or createFileFromStream, the exact content passed into createFile/createFileFromStream will be used.\n * For true instances of Blob and File, returns the blob's content as a Web ReadableStream.\n *\n * @internal\n */\nexport function getRawContent(\n blob: Blob,\n): NodeJS.ReadableStream | ReadableStream | Uint8Array {\n if (hasRawContent(blob)) {\n return blob[rawContent]();\n } else {\n return blob.stream();\n }\n}\n\n/**\n * Create an object that implements the File interface. This object is intended to be\n * passed into RequestBodyType.formData, and is not guaranteed to work as expected in\n * other situations.\n *\n * Use this function to:\n * - Create a File object for use in RequestBodyType.formData in environments where the\n * global File object is unavailable.\n * - Create a File-like object from a readable stream without reading the stream into memory.\n *\n * @param stream - the content of the file as a callback returning a stream. When a File object made using createFile is\n * passed in a request's form data map, the stream will not be read into memory\n * and instead will be streamed when the request is made. In the event of a retry, the\n * stream needs to be read again, so this callback SHOULD return a fresh stream if possible.\n * @param name - the name of the file.\n * @param options - optional metadata about the file, e.g. file name, file size, MIME type.\n */\nexport function createFileFromStream(\n stream: () => ReadableStream | NodeJS.ReadableStream,\n name: string,\n options: CreateFileFromStreamOptions = {},\n): File {\n return {\n ...unimplementedMethods,\n type: options.type ?? \"\",\n lastModified: options.lastModified ?? new Date().getTime(),\n webkitRelativePath: options.webkitRelativePath ?? \"\",\n size: options.size ?? -1,\n name,\n stream: () => {\n const s = stream();\n if (isNodeReadableStream(s)) {\n throw new Error(\n \"Not supported: a Node stream was provided as input to createFileFromStream.\",\n );\n }\n\n return s;\n },\n [rawContent]: stream,\n } as File & RawContent;\n}\n\n/**\n * Create an object that implements the File interface. This object is intended to be\n * passed into RequestBodyType.formData, and is not guaranteed to work as expected in\n * other situations.\n *\n * Use this function create a File object for use in RequestBodyType.formData in environments where the global File object is unavailable.\n *\n * @param content - the content of the file as a Uint8Array in memory.\n * @param name - the name of the file.\n * @param options - optional metadata about the file, e.g. file name, file size, MIME type.\n */\nexport function createFile(\n content: Uint8Array,\n name: string,\n options: CreateFileOptions = {},\n): File {\n if (isNodeLike) {\n return {\n ...unimplementedMethods,\n type: options.type ?? \"\",\n lastModified: options.lastModified ?? new Date().getTime(),\n webkitRelativePath: options.webkitRelativePath ?? \"\",\n size: content.byteLength,\n name,\n arrayBuffer: async () => content.buffer,\n stream: () => new Blob([content]).stream(),\n [rawContent]: () => content,\n } as File & RawContent;\n } else {\n return new File([content], name, options);\n }\n}\n"]} \ No newline at end of file diff --git a/node_modules/@azure/core-rest-pipeline/package.json b/node_modules/@azure/core-rest-pipeline/package.json index 18dc145a..b701fb3d 100644 --- a/node_modules/@azure/core-rest-pipeline/package.json +++ b/node_modules/@azure/core-rest-pipeline/package.json @@ -1,6 +1,6 @@ { "name": "@azure/core-rest-pipeline", - "version": "1.18.1", + "version": "1.18.2", "description": "Isomorphic client library for making HTTP requests in node.js and browser.", "sdk-type": "client", "type": "module", @@ -62,8 +62,8 @@ "integration-test": "npm run integration-test:node && npm run integration-test:browser", "integration-test:browser": "echo skipped", "integration-test:node": "echo skipped", - "lint": "eslint package.json api-extractor.json src", - "lint:fix": "eslint package.json api-extractor.json src --fix --fix-type [problem,suggestion]", + "lint": "eslint README.md package.json api-extractor.json src test", + "lint:fix": "eslint README.md package.json api-extractor.json src test --fix --fix-type [problem,suggestion]", "pack": "npm pack 2>&1", "test": "npm run clean && dev-tool run build-package && npm run unit-test:node && dev-tool run build-test && npm run unit-test:browser && npm run integration-test", "test:browser": "npm run clean && npm run unit-test:browser && npm run integration-test:browser", @@ -109,7 +109,7 @@ "@vitest/coverage-istanbul": "^2.0.5", "eslint": "^9.9.0", "playwright": "^1.41.2", - "typescript": "~5.6.2", + "typescript": "~5.7.2", "vitest": "^2.0.5" }, "tshy": { @@ -125,7 +125,8 @@ "browser", "react-native" ], - "selfLink": false + "selfLink": false, + "project": "./tsconfig.src.json" }, "module": "./dist/esm/index.js" } diff --git a/node_modules/@octokit/request-error/node_modules/@octokit/openapi-types/package.json b/node_modules/@octokit/request-error/node_modules/@octokit/openapi-types/package.json index 350a5825..9163156a 100644 --- a/node_modules/@octokit/request-error/node_modules/@octokit/openapi-types/package.json +++ b/node_modules/@octokit/request-error/node_modules/@octokit/openapi-types/package.json @@ -10,12 +10,12 @@ "access": "public", "provenance": true }, - "version": "22.2.0", + "version": "23.0.1", "main": "", "types": "types.d.ts", "author": "Gregor Martynus (https://twitter.com/gr2m)", "license": "MIT", "octokit": { - "openapi-version": "16.5.0" + "openapi-version": "17.1.1" } } diff --git a/node_modules/@octokit/request-error/node_modules/@octokit/openapi-types/types.d.ts b/node_modules/@octokit/request-error/node_modules/@octokit/openapi-types/types.d.ts index afa653c5..998a326d 100644 --- a/node_modules/@octokit/request-error/node_modules/@octokit/openapi-types/types.d.ts +++ b/node_modules/@octokit/request-error/node_modules/@octokit/openapi-types/types.d.ts @@ -138,8 +138,6 @@ export interface paths { * * 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. */ post: operations["apps/create-installation-access-token"]; @@ -163,7 +161,7 @@ export interface paths { "/applications/{client_id}/grant": { /** * 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. + * @description OAuth and GitHub application owners can revoke a grant for their application and a specific user. You must 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). */ delete: operations["apps/delete-authorization"]; @@ -171,17 +169,17 @@ export interface paths { "/applications/{client_id}/token": { /** * 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`. + * @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. Invalid tokens will return `404 NOT FOUND`. */ post: operations["apps/check-token"]; /** * 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. + * @description OAuth or GitHub application owners can revoke a single token for an OAuth application or a GitHub application with an OAuth authorization. */ delete: operations["apps/delete-token"]; /** * 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`. + * @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. Invalid tokens will return `404 NOT FOUND`. */ patch: operations["apps/reset-token"]; }; @@ -193,17 +191,14 @@ export interface paths { * 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. */ post: operations["apps/scope-token"]; }; "/apps/{app_slug}": { /** * 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`). + * @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"]; }; @@ -270,25 +265,104 @@ export interface paths { */ get: operations["emojis/get"]; }; - "/enterprises/{enterprise}/copilot/usage": { + "/enterprises/{enterprise}/code-security/configurations": { /** - * Get a summary of Copilot usage for enterprise members - * @description **Note**: This endpoint is in beta and is subject to change. + * Get code security configurations for an enterprise + * @description Lists all code security configurations available in an enterprise. * - * 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 authenticated user must be an administrator of the enterprise in order to use this endpoint. * - * 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. + * OAuth app tokens and personal access tokens (classic) need the `read:enterprise` scope to use this endpoint. + */ + get: operations["code-security/get-configurations-for-enterprise"]; + /** + * Create a code security configuration for an enterprise + * @description Creates a code security configuration in an 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. + */ + post: operations["code-security/create-configuration-for-enterprise"]; + }; + "/enterprises/{enterprise}/code-security/configurations/defaults": { + /** + * Get default code security configurations for an enterprise + * @description Lists the default code security configurations for an enterprise. * - * Only the owners and billing managers of enterprises with a Copilot Business or Enterprise subscription can view Copilot usage - * metrics for the 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 `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 `read:enterprise` scope to use this endpoint. */ - get: operations["copilot/usage-metrics-for-enterprise"]; + get: operations["code-security/get-default-configurations-for-enterprise"]; + }; + "/enterprises/{enterprise}/code-security/configurations/{configuration_id}": { + /** + * Retrieve a code security configuration of an enterprise + * @description Gets a code security configuration available in an 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 `read:enterprise` scope to use this endpoint. + */ + get: operations["code-security/get-single-configuration-for-enterprise"]; + /** + * Delete a code security configuration for an enterprise + * @description Deletes a code security configuration from an enterprise. + * Repositories attached to the configuration will retain their settings but will no longer be associated with + * the configuration. + * + * The authenticated user must be an administrator for the enterprise to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + */ + delete: operations["code-security/delete-configuration-for-enterprise"]; + /** + * Update a custom code security configuration for an enterprise + * @description Updates a code security configuration in an 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. + */ + patch: operations["code-security/update-enterprise-configuration"]; + }; + "/enterprises/{enterprise}/code-security/configurations/{configuration_id}/attach": { + /** + * Attach an enterprise configuration to repositories + * @description Attaches an enterprise code security configuration to repositories. If the repositories specified are already attached to a configuration, they will be re-attached to the provided configuration. + * + * If insufficient GHAS licenses are available to attach the configuration to a repository, only free features will be enabled. + * + * The authenticated user must be an administrator for the enterprise to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + */ + post: operations["code-security/attach-enterprise-configuration"]; + }; + "/enterprises/{enterprise}/code-security/configurations/{configuration_id}/defaults": { + /** + * Set a code security configuration as a default for an enterprise + * @description Sets a code security configuration as a default to be applied to new repositories in your enterprise. + * + * This configuration will be applied by default to the matching repository type when created, but only for organizations within the enterprise that do not already have a default code security configuration set. + * + * The authenticated user must be an administrator for the enterprise to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + */ + put: operations["code-security/set-configuration-as-default-for-enterprise"]; + }; + "/enterprises/{enterprise}/code-security/configurations/{configuration_id}/repositories": { + /** + * Get repositories associated with an enterprise code security configuration + * @description Lists the repositories associated with an enterprise code security configuration in an organization. + * + * 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 `read:enterprise` scope to use this endpoint. + */ + get: operations["code-security/get-repositories-for-enterprise-configuration"]; }; "/enterprises/{enterprise}/dependabot/alerts": { /** @@ -319,7 +393,8 @@ export interface paths { "/events": { /** * 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. + * @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-public-events"]; }; @@ -338,7 +413,8 @@ export interface paths { * * 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/authentication/authenticating-to-the-rest-api#using-basic-authentication) since current feed URIs use the older, non revocable auth tokens. */ get: operations["activity/get-feeds"]; }; @@ -352,7 +428,8 @@ export interface paths { * 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"]; }; @@ -511,10 +588,8 @@ export interface paths { * 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)." * @@ -555,7 +630,7 @@ export interface paths { * 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/authentication/authenticating-to-the-rest-api#using-basic-authentication) with their client ID and client secret to access this endpoint. */ get: operations["apps/get-subscription-plan-for-account"]; }; @@ -564,7 +639,7 @@ export interface paths { * 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/authentication/authenticating-to-the-rest-api#using-basic-authentication) with their client ID and client secret to access this endpoint. */ get: operations["apps/list-plans"]; }; @@ -573,7 +648,7 @@ export interface paths { * 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/authentication/authenticating-to-the-rest-api#using-basic-authentication) with their client ID and client secret to access this endpoint. */ get: operations["apps/list-accounts-for-plan"]; }; @@ -582,7 +657,7 @@ export interface paths { * 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/authentication/authenticating-to-the-rest-api#using-basic-authentication) with their client ID and client secret to access this endpoint. */ get: operations["apps/get-subscription-plan-for-account-stubbed"]; }; @@ -591,7 +666,7 @@ export interface paths { * 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/authentication/authenticating-to-the-rest-api#using-basic-authentication) with their client ID and client secret to access this endpoint. */ get: operations["apps/list-plans-stubbed"]; }; @@ -600,7 +675,7 @@ export interface paths { * 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/authentication/authenticating-to-the-rest-api#using-basic-authentication) with their client ID and client secret to access this endpoint. */ get: operations["apps/list-accounts-for-plan-stubbed"]; }; @@ -613,12 +688,17 @@ export interface paths { * * 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"]; }; "/networks/{owner}/{repo}/events": { - /** List public events for a network of repositories */ + /** + * List public events for a network of repositories + * @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-public-events-for-repo-network"]; }; "/notifications": { @@ -685,10 +765,20 @@ export interface paths { * 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"]; }; + "/organizations/{org}/settings/billing/usage": { + /** + * Get billing usage report for an organization + * @description Gets a report of the total usage for an organization. To use this endpoint, you must be an administrator of an organization within an enterprise or an organization account. + * + * **Note:** This endpoint is only available to organizations with access to the enhanced billing platform. For more information, see "[About the enhanced billing platform](https://docs.github.com/billing/using-the-new-billing-platform)." + */ + get: operations["billing/get-github-billing-usage-report-org"]; + }; "/orgs/{org}": { /** * Get an organization @@ -698,17 +788,6 @@ export interface paths { * * 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. @@ -727,20 +806,13 @@ export interface paths { delete: operations["orgs/delete"]; /** * 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: + * @description > [!WARNING] + * > **Closing down 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). * - * - 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 + * > [!WARNING] + * > **Closing down notice:** Code security product enablement for new repositories through the organization API is closing down. Please use [code security configurations](https://docs.github.com/rest/code-security/configurations#set-a-code-security-configuration-as-a-default-for-an-organization) to set defaults instead. For more information on setting a default security configuration, see the [changelog](https://github.blog/changelog/2024-07-09-sunsetting-security-settings-defaults-parameters-in-the-organizations-rest-api/). * - * 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)." + * Updates the organization's profile and member privileges. * * The authenticated user must be an organization owner to use this endpoint. * @@ -869,6 +941,109 @@ export interface paths { */ put: operations["actions/set-github-actions-default-workflow-permissions-organization"]; }; + "/orgs/{org}/actions/runner-groups": { + /** + * 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. + */ + get: operations["actions/list-self-hosted-runner-groups-for-org"]; + /** + * 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. + */ + post: operations["actions/create-self-hosted-runner-group-for-org"]; + }; + "/orgs/{org}/actions/runner-groups/{runner_group_id}": { + /** + * 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. + */ + get: operations["actions/get-self-hosted-runner-group-for-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. + */ + delete: operations["actions/delete-self-hosted-runner-group-from-org"]; + /** + * 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. + */ + patch: operations["actions/update-self-hosted-runner-group-for-org"]; + }; + "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories": { + /** + * 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. + */ + 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. + */ + put: operations["actions/set-repo-access-to-self-hosted-runner-group-in-org"]; + }; + "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories/{repository_id}": { + /** + * 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. + */ + put: operations["actions/add-repo-access-to-self-hosted-runner-group-in-org"]; + /** + * 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. + */ + delete: operations["actions/remove-repo-access-to-self-hosted-runner-group-in-org"]; + }; + "/orgs/{org}/actions/runner-groups/{runner_group_id}/runners": { + /** + * 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. + */ + 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. + */ + put: operations["actions/set-self-hosted-runners-in-group-for-org"]; + }; + "/orgs/{org}/actions/runner-groups/{runner_group_id}/runners/{runner_id}": { + /** + * 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. + */ + put: operations["actions/add-self-hosted-runner-to-group-for-org"]; + /** + * 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. + */ + delete: operations["actions/remove-self-hosted-runner-from-group-for-org"]; + }; "/orgs/{org}/actions/runners": { /** * List self-hosted runners for an organization @@ -1276,6 +1451,17 @@ export interface paths { */ delete: operations["actions/remove-selected-repo-from-org-variable"]; }; + "/orgs/{org}/attestations/{subject_digest}": { + /** + * List attestations + * @description List a collection of artifact attestations with a given subject digest that are associated with repositories owned by an organization. + * + * The collection of attestations returned by this endpoint is filtered according to the authenticated user's permissions; if the authenticated user cannot read a repository, the attestations associated with that repository will not be included in the response. In addition, when using a fine-grained access token the `attestations:read` permission is required. + * + * **Please note:** in order to offer meaningful security benefits, an attestation's signature and timestamps **must** be cryptographically verified, and the identity of the attestation signer **must** be validated. Attestations can be verified using the [GitHub CLI `attestation verify` command](https://cli.github.com/manual/gh_attestation_verify). For more information, see [our guide on how to use artifact attestations to establish a build's provenance](https://docs.github.com/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds). + */ + get: operations["orgs/list-attestations"]; + }; "/orgs/{org}/blocks": { /** * List users blocked by an organization @@ -1311,6 +1497,117 @@ export interface paths { */ get: operations["code-scanning/list-alerts-for-org"]; }; + "/orgs/{org}/code-security/configurations": { + /** + * Get code security configurations for an organization + * @description Lists all code security configurations available in an 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 `write:org` scope to use this endpoint. + */ + get: operations["code-security/get-configurations-for-org"]; + /** + * Create a code security configuration + * @description Creates a code security configuration in an 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 `write:org` scope to use this endpoint. + */ + post: operations["code-security/create-configuration"]; + }; + "/orgs/{org}/code-security/configurations/defaults": { + /** + * Get default code security configurations + * @description Lists the default code security configurations for an 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 `write:org` scope to use this endpoint. + */ + get: operations["code-security/get-default-configurations"]; + }; + "/orgs/{org}/code-security/configurations/detach": { + /** + * Detach configurations from repositories + * @description Detach code security configuration(s) from a set of repositories. + * Repositories will retain their settings but will no longer be associated with the configuration. + * + * 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 `write:org` scope to use this endpoint. + */ + delete: operations["code-security/detach-configuration"]; + }; + "/orgs/{org}/code-security/configurations/{configuration_id}": { + /** + * Get a code security configuration + * @description Gets a code security configuration available in an 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 `write:org` scope to use this endpoint. + */ + get: operations["code-security/get-configuration"]; + /** + * Delete a code security configuration + * @description Deletes the desired code security configuration from an organization. + * Repositories attached to the configuration will retain their settings but will no longer be associated with + * the configuration. + * + * 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 `write:org` scope to use this endpoint. + */ + delete: operations["code-security/delete-configuration"]; + /** + * Update a code security configuration + * @description Updates a code security configuration in an 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 `write:org` scope to use this endpoint. + */ + patch: operations["code-security/update-configuration"]; + }; + "/orgs/{org}/code-security/configurations/{configuration_id}/attach": { + /** + * Attach a configuration to repositories + * @description Attach a code security configuration to a set of repositories. If the repositories specified are already attached to a configuration, they will be re-attached to the provided configuration. + * + * If insufficient GHAS licenses are available to attach the configuration to a repository, only free features will be enabled. + * + * 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 `write:org` scope to use this endpoint. + */ + post: operations["code-security/attach-configuration"]; + }; + "/orgs/{org}/code-security/configurations/{configuration_id}/defaults": { + /** + * Set a code security configuration as a default for an organization + * @description Sets a code security configuration as a default to be applied to new repositories in your organization. + * + * This configuration will be applied to the matching repository type (all, none, public, private and internal) by default when they are created. + * + * 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 `write:org` scope to use this endpoint. + */ + put: operations["code-security/set-configuration-as-default"]; + }; + "/orgs/{org}/code-security/configurations/{configuration_id}/repositories": { + /** + * Get repositories associated with a code security configuration + * @description Lists the repositories associated with a code security configuration in an 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 `write:org` scope to use this endpoint. + */ + get: operations["code-security/get-repositories-for-configuration"]; + }; "/orgs/{org}/codespaces": { /** * List codespaces for the organization @@ -1434,116 +1731,141 @@ export interface paths { "/orgs/{org}/copilot/billing": { /** * Get Copilot seat information and settings for an organization - * @description **Note**: This endpoint is in beta and is subject to change. + * @description > [!NOTE] + * > This endpoint is in public preview 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)". + * and feature 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 view details about the organization's Copilot Business or Copilot 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 either the `manage_billing:copilot` or `read:org` scopes to use this endpoint. */ get: operations["copilot/get-copilot-organization-details"]; }; "/orgs/{org}/copilot/billing/seats": { /** * List all Copilot seat assignments for an organization - * @description **Note**: This endpoint is in beta and is subject to change. + * @description > [!NOTE] + * > This endpoint is in public preview 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 seats for which an organization with a Copilot Business or Copilot Enterprise subscription is currently being billed. + * Only organization owners can view assigned seats. * - * Only organization owners can configure and view details about the organization's Copilot Business or Enterprise subscription. + * Each seat object contains information about the assigned user's most recent Copilot activity. Users must have telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`. + * For more information about activity data, see "[Reviewing user activity data for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-user-activity-data-for-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 either the `manage_billing:copilot` or `read:org` scopes to use this endpoint. */ get: operations["copilot/list-copilot-seats"]; }; "/orgs/{org}/copilot/billing/selected_teams": { /** * Add teams to the Copilot subscription for an organization - * @description **Note**: This endpoint is in beta and is subject to change. + * @description > [!NOTE] + * > This endpoint is in public preview 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)". + * The organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see "[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization)." * - * Only organization owners can configure GitHub Copilot in their organization. + * Only organization owners can purchase Copilot seats for their organization members. The organization must have a Copilot Business or Copilot Enterprise subscription and a configured suggestion matching policy. + * For more information about setting up a Copilot subscription, see "[Subscribing to Copilot for your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/subscribing-to-copilot-for-your-organization)." + * For more information about setting a suggestion matching policy, see "[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching)." * - * 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)". + * The response contains the total number of new seats that were created and existing seats that were refreshed. * - * 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 either the `manage_billing:copilot` or `admin:org` scopes 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. + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. * - * 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)". + * Sets seats for all members of each team specified to "pending cancellation". + * This will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through another team. + * For more information about disabling access to Copilot, see "[Revoking access to Copilot for members of your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-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 cancel Copilot seats for their organization members. * - * Only organization owners can configure GitHub Copilot in their organization. + * The response contains the total number of seats set to "pending cancellation". * - * 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 either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. */ delete: operations["copilot/cancel-copilot-seat-assignment-for-teams"]; }; "/orgs/{org}/copilot/billing/selected_users": { /** * Add users to the Copilot subscription for an organization - * @description **Note**: This endpoint is in beta and is subject to change. + * @description > [!NOTE] + * > This endpoint is in public preview 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)". + * The organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see "[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization)." * - * Only organization owners can configure GitHub Copilot in their organization. + * Only organization owners can purchase Copilot seats for their organization members. The organization must have a Copilot Business or Copilot Enterprise subscription and a configured suggestion matching policy. + * For more information about setting up a Copilot subscription, see "[Subscribing to Copilot for your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/subscribing-to-copilot-for-your-organization)." + * For more information about setting a suggestion matching policy, see "[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching)." * - * 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)". + * The response contains the total number of new seats that were created and existing seats that were refreshed. * - * 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 either the `manage_billing:copilot` or `admin:org` scopes 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. + * @description > [!NOTE] + * > This endpoint is in public preview 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. + * Sets seats for all users specified to "pending cancellation". + * This will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through team membership. + * For more information about disabling access to Copilot, see "[Revoking access to Copilot for members of your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization)." * - * 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 cancel Copilot seats for their organization members. * - * 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)". + * The response contains the total number of seats set to "pending cancellation". * - * 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 either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. */ delete: operations["copilot/cancel-copilot-seat-assignment-for-users"]; }; + "/orgs/{org}/copilot/metrics": { + /** + * Get Copilot metrics for an organization + * @description Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions. + * + * > [!NOTE] + * > This endpoint will only return results for a given day if the organization contained **five or more members with active Copilot licenses** on that day, as evaluated at the end of that day. + * + * The response contains metrics for up to 28 days prior. 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. + * + * To access this endpoint, the Copilot Metrics API access policy must be enabled for the organization. + * Only organization owners and owners and billing managers of the parent enterprise can view Copilot metrics. + * + * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot`, `read:org`, or `read:enterprise` scopes to use this endpoint. + */ + get: operations["copilot/copilot-metrics-for-organization"]; + }; "/orgs/{org}/copilot/usage": { /** * Get a summary of Copilot usage for organization members - * @description **Note**: This endpoint is in beta and is subject to change. + * @description > [!NOTE] + * > This endpoint is in public preview 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, + * The response contains metrics for up to 28 days prior. 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. + * Organization owners, and owners and billing managers of the parent enterprise, 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 either the `manage_billing:copilot`, `read:org`, or `read:enterprise` scopes to use this endpoint. */ get: operations["copilot/usage-metrics-for-org"]; }; @@ -1722,7 +2044,11 @@ export interface paths { get: operations["packages/list-docker-migration-conflicting-packages-for-organization"]; }; "/orgs/{org}/events": { - /** List public organization events */ + /** + * List public organization 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-public-org-events"]; }; "/orgs/{org}/failed_invitations": { @@ -1735,7 +2061,9 @@ export interface paths { "/orgs/{org}/hooks": { /** * List organization webhooks - * @description You must be an organization owner to use this endpoint. + * @description List webhooks for an organization. + * + * The authenticated user 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. @@ -1766,7 +2094,9 @@ export interface paths { get: operations["orgs/get-webhook"]; /** * Delete an organization webhook - * @description You must be an organization owner to use this endpoint. + * @description Delete a webhook for an organization. + * + * The authenticated user 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. @@ -1858,6 +2188,69 @@ export interface paths { */ post: operations["orgs/ping-webhook"]; }; + "/orgs/{org}/insights/api/route-stats/{actor_type}/{actor_id}": { + /** + * Get route stats by actor + * @description Get API request count statistics for an actor broken down by route within a specified time frame. + */ + get: operations["api-insights/get-route-stats-by-actor"]; + }; + "/orgs/{org}/insights/api/subject-stats": { + /** + * Get subject stats + * @description Get API request statistics for all subjects within an organization within a specified time frame. Subjects can be users or GitHub Apps. + */ + get: operations["api-insights/get-subject-stats"]; + }; + "/orgs/{org}/insights/api/summary-stats": { + /** + * Get summary stats + * @description Get overall statistics of API requests made within an organization by all users and apps within a specified time frame. + */ + get: operations["api-insights/get-summary-stats"]; + }; + "/orgs/{org}/insights/api/summary-stats/users/{user_id}": { + /** + * Get summary stats by user + * @description Get overall statistics of API requests within the organization for a user. + */ + get: operations["api-insights/get-summary-stats-by-user"]; + }; + "/orgs/{org}/insights/api/summary-stats/{actor_type}/{actor_id}": { + /** + * Get summary stats by actor + * @description Get overall statistics of API requests within the organization made by a specific actor. Actors can be GitHub App installations, OAuth apps or other tokens on behalf of a user. + */ + get: operations["api-insights/get-summary-stats-by-actor"]; + }; + "/orgs/{org}/insights/api/time-stats": { + /** + * Get time stats + * @description Get the number of API requests and rate-limited requests made within an organization over a specified time period. + */ + get: operations["api-insights/get-time-stats"]; + }; + "/orgs/{org}/insights/api/time-stats/users/{user_id}": { + /** + * Get time stats by user + * @description Get the number of API requests and rate-limited requests made within an organization by a specific user over a specified time period. + */ + get: operations["api-insights/get-time-stats-by-user"]; + }; + "/orgs/{org}/insights/api/time-stats/{actor_type}/{actor_id}": { + /** + * Get time stats by actor + * @description Get the number of API requests and rate-limited requests made within an organization by a specific actor within a specified time period. + */ + get: operations["api-insights/get-time-stats-by-actor"]; + }; + "/orgs/{org}/insights/api/user-stats/{user_id}": { + /** + * Get user stats + * @description Get API usage statistics within an organization for a user broken down by the type of access. + */ + get: operations["api-insights/get-user-stats"]; + }; "/orgs/{org}/installation": { /** * Get an organization installation for the authenticated app @@ -1899,14 +2292,17 @@ export interface paths { "/orgs/{org}/invitations": { /** * 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`. + * @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"]; /** * 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)" + * 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/using-the-rest-api/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"]; @@ -1932,10 +2328,8 @@ export interface paths { * 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)." * @@ -1995,13 +2389,17 @@ export interface paths { "/orgs/{org}/members/{username}/copilot": { /** * Get Copilot seat assignment details for a user - * @description **Note**: This endpoint is in beta and is subject to change. + * @description > [!NOTE] + * > This endpoint is in public preview 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 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. + * The seat object contains information about the user's most recent Copilot activity. Users must have telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`. + * For more information about activity data, see "[Reviewing user activity data for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-user-activity-data-for-copilot-in-your-organization)." * - * OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. + * Only organization owners can view Copilot seat assignment details for members of their organization. + * + * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint. */ get: operations["copilot/get-copilot-seat-details-for-user"]; }; @@ -2021,7 +2419,7 @@ export interface paths { * * **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, organization owners are limited to creating 50 organization invitations for an organization within a 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"]; /** @@ -2086,26 +2484,10 @@ export interface paths { */ get: operations["migrations/list-repos-for-org"]; }; - "/orgs/{org}/organization-fine-grained-permissions": { - /** - * 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. - */ - get: operations["orgs/list-organization-fine-grained-permissions"]; - }; "/orgs/{org}/organization-roles": { /** * 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)." + * @description Lists the organization roles available in this organization. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." * * To use this endpoint, the authenticated user must be one of: * @@ -2115,23 +2497,11 @@ export interface paths { * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ get: operations["orgs/list-org-roles"]; - /** - * 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. - */ - post: operations["orgs/create-custom-organization-role"]; }; "/orgs/{org}/organization-roles/teams/{team_slug}": { /** * 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)." + * @description Removes all assigned organization roles from a team. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." * * The authenticated user must be an administrator for the organization to use this endpoint. * @@ -2142,7 +2512,7 @@ export interface paths { "/orgs/{org}/organization-roles/teams/{team_slug}/{role_id}": { /** * 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)." + * @description Assigns an organization role to a team in an organization. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." * * The authenticated user must be an administrator for the organization to use this endpoint. * @@ -2151,7 +2521,7 @@ export interface paths { put: operations["orgs/assign-team-to-org-role"]; /** * 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)." + * @description Removes an organization role from a team. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." * * The authenticated user must be an administrator for the organization to use this endpoint. * @@ -2162,7 +2532,7 @@ export interface paths { "/orgs/{org}/organization-roles/users/{username}": { /** * 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)." + * @description Revokes all assigned organization roles from a user. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." * * The authenticated user must be an administrator for the organization to use this endpoint. * @@ -2173,7 +2543,7 @@ export interface paths { "/orgs/{org}/organization-roles/users/{username}/{role_id}": { /** * 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)." + * @description Assigns an organization role to a member of an organization. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." * * The authenticated user must be an administrator for the organization to use this endpoint. * @@ -2182,7 +2552,7 @@ export interface paths { put: operations["orgs/assign-user-to-org-role"]; /** * 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)." + * @description Remove an organization role from a user. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." * * The authenticated user must be an administrator for the organization to use this endpoint. * @@ -2193,7 +2563,7 @@ export interface paths { "/orgs/{org}/organization-roles/{role_id}": { /** * 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)." + * @description Gets an organization role that is available to this organization. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." * * To use this endpoint, the authenticated user must be one of: * @@ -2203,36 +2573,11 @@ export interface paths { * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ get: operations["orgs/get-org-role"]; - /** - * 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. - */ - delete: operations["orgs/delete-custom-organization-role"]; - /** - * 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. - */ - patch: operations["orgs/patch-custom-organization-role"]; }; "/orgs/{org}/organization-roles/{role_id}/teams": { /** * 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)." + * @description Lists the teams that are assigned to an organization role. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." * * To use this endpoint, you must be an administrator for the organization. * @@ -2243,7 +2588,7 @@ export interface paths { "/orgs/{org}/organization-roles/{role_id}/users": { /** * 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)." + * @description Lists organization members that are assigned to an organization role. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." * * To use this endpoint, you must be an administrator for the organization. * @@ -2275,7 +2620,7 @@ export interface paths { * 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. For more information, 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"]; }; @@ -2284,7 +2629,7 @@ export interface paths { * 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. For more information, 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"]; /** @@ -2293,7 +2638,7 @@ export interface paths { * * 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. For more information, 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"]; }; @@ -2308,7 +2653,7 @@ export interface paths { * * 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. For more information, 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"]; }; @@ -2317,7 +2662,7 @@ export interface paths { * 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 `read:packages` scope to use this endpoint. For more information, 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"]; }; @@ -2326,7 +2671,7 @@ export interface paths { * 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. For more information, 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"]; /** @@ -2335,7 +2680,7 @@ export interface paths { * * 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. For more information, 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"]; }; @@ -2350,7 +2695,7 @@ export interface paths { * * 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. For more information, 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"]; }; @@ -2422,6 +2767,73 @@ export interface paths { */ get: operations["orgs/list-pat-grant-repositories"]; }; + "/orgs/{org}/private-registries": { + /** + * List private registries for an organization + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. + * + * Lists all private registry configurations 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. + */ + get: operations["private-registries/list-org-private-registries"]; + /** + * Create a private registry for an organization + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. + * + * Creates a private registry configuration with an encrypted value for an organization. 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. + */ + post: operations["private-registries/create-org-private-registry"]; + }; + "/orgs/{org}/private-registries/public-key": { + /** + * Get private registries public key for an organization + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. + * + * Gets the org public key, which is needed to encrypt private registry secrets. You need to encrypt a secret before you can create or update secrets. + * + * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + get: operations["private-registries/get-org-public-key"]; + }; + "/orgs/{org}/private-registries/{secret_name}": { + /** + * Get a private registry for an organization + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. + * + * Get the configuration of a single private registry defined for an organization, omitting its encrypted value. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + get: operations["private-registries/get-org-private-registry"]; + /** + * Delete a private registry for an organization + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. + * + * Delete a private registry configuration at the organization-level. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + delete: operations["private-registries/delete-org-private-registry"]; + /** + * Update a private registry for an organization + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. + * + * Updates a private registry configuration with an encrypted value for an organization. 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. + */ + patch: operations["private-registries/update-org-private-registry"]; + }; "/orgs/{org}/projects": { /** * List organization projects @@ -2530,7 +2942,8 @@ export interface paths { * 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"]; /** @@ -2573,6 +2986,9 @@ export interface paths { /** * Get an organization repository ruleset * @description Get a repository ruleset for an organization. + * + * **Note:** To prevent leaking sensitive information, the `bypass_actors` property is only returned if the user + * making the API request has write access to the ruleset. */ get: operations["repos/get-org-ruleset"]; /** @@ -2611,31 +3027,25 @@ export interface paths { "/orgs/{org}/security-managers": { /** * 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. + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** This operation is closing down and will be removed starting January 1, 2026. Please use the "[Organization Roles](https://docs.github.com/rest/orgs/organization-roles)" endpoints instead. */ get: operations["orgs/list-security-manager-teams"]; }; "/orgs/{org}/security-managers/teams/{team_slug}": { /** * 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. + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** This operation is closing down and will be removed starting January 1, 2026. Please use the "[Organization Roles](https://docs.github.com/rest/orgs/organization-roles)" endpoints instead. */ put: operations["orgs/add-security-manager-team"]; /** * 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. + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** This operation is closing down and will be removed starting January 1, 2026. Please use the "[Organization Roles](https://docs.github.com/rest/orgs/organization-roles)" endpoints instead. */ delete: operations["orgs/remove-security-manager-team"]; }; @@ -2672,25 +3082,45 @@ export interface paths { */ get: operations["billing/get-shared-storage-billing-org"]; }; + "/orgs/{org}/team/{team_slug}/copilot/metrics": { + /** + * Get Copilot metrics for a team + * @description Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions. + * + * > [!NOTE] + * > This endpoint will only return results for a given day if the team had **five or more members with active Copilot licenses** on that day, as evaluated at the end of that day. + * + * The response contains metrics for up to 28 days prior. 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. + * + * To access this endpoint, the Copilot Metrics API access policy must be enabled for the organization containing the team within GitHub settings. + * Only organization owners for the organization that contains this team and owners and billing managers of the parent enterprise can view Copilot metrics for a team. + * + * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot`, `read:org`, or `read:enterprise` scopes to use this endpoint. + */ + get: operations["copilot/copilot-metrics-for-team"]; + }; "/orgs/{org}/team/{team_slug}/copilot/usage": { /** * Get a summary of Copilot usage for a team - * @description **Note**: This endpoint is in beta and is subject to change. + * @description > [!NOTE] + * > This endpoint is in public preview 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, + * The response contains metrics for up to 28 days prior. 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 with active Copilot licenses, as evaluated at the end of 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. + * Organization owners for the organization that contains this team, and owners and billing managers of the parent enterprise 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 either the `manage_billing:copilot`, `read:org`, or `read:enterprise` scopes to use this endpoint. */ get: operations["copilot/usage-metrics-for-team"]; }; @@ -2713,7 +3143,8 @@ export interface paths { * 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"]; /** @@ -2722,14 +3153,16 @@ export interface paths { * * 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"]; /** * 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"]; }; @@ -2738,7 +3171,8 @@ export interface paths { * 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. */ @@ -2747,9 +3181,10 @@ export interface paths { * 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/using-the-rest-api/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. */ @@ -2760,7 +3195,8 @@ export interface paths { * 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. */ @@ -2769,7 +3205,8 @@ export interface paths { * 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. */ @@ -2778,7 +3215,8 @@ export interface paths { * 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. */ @@ -2789,7 +3227,8 @@ export interface paths { * 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. */ @@ -2798,9 +3237,10 @@ export interface paths { * 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/using-the-rest-api/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. */ @@ -2811,7 +3251,8 @@ export interface paths { * 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. */ @@ -2820,7 +3261,8 @@ export interface paths { * 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. */ @@ -2829,7 +3271,8 @@ export interface paths { * 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. */ @@ -2840,7 +3283,8 @@ export interface paths { * 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. */ @@ -2851,7 +3295,8 @@ export interface paths { * * 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. */ @@ -2860,7 +3305,8 @@ export interface paths { "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions/{reaction_id}": { /** * 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`. + * @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). * @@ -2873,7 +3319,8 @@ export interface paths { * 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. */ @@ -2884,7 +3331,8 @@ export interface paths { * * 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. */ @@ -2893,7 +3341,8 @@ export interface paths { "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions/{reaction_id}": { /** * 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`. + * @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). * @@ -2906,7 +3355,8 @@ export interface paths { * 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"]; }; @@ -2926,10 +3376,11 @@ export interface paths { * * 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). */ @@ -2940,13 +3391,15 @@ export interface paths { * * 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. * * 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"]; /** @@ -2955,9 +3408,11 @@ export interface paths { * * 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"]; }; @@ -2966,7 +3421,8 @@ export interface paths { * 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"]; }; @@ -2975,21 +3431,24 @@ export interface paths { * 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"]; /** * 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"]; }; @@ -2998,7 +3457,8 @@ export interface paths { * 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"]; }; @@ -3007,20 +3467,22 @@ export interface paths { * 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/using-the-rest-api/getting-started-with-the-rest-api#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}`. + * > [!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)". */ @@ -3029,7 +3491,8 @@ export interface paths { * 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"]; }; @@ -3038,18 +3501,23 @@ export interface paths { * 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"]; }; "/orgs/{org}/{security_product}/{enablement}": { /** * 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)." + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** The ability to enable or disable a security feature for all eligible repositories in an organization is closing down. Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. For more information, see the [changelog](https://github.blog/changelog/2024-07-22-deprecation-of-api-endpoint-to-enable-or-disable-a-security-feature-for-an-organization/). + * + * 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. + * OAuth app tokens and personal access tokens (classic) need the `admin:org`, `write:org`, or `repo` scopes to use this endpoint. */ post: operations["orgs/enable-or-disable-security-product-on-all-org-repos"]; }; @@ -3156,7 +3624,8 @@ export interface paths { "/rate_limit": { /** * Get rate limit status for the authenticated user - * @description **Note:** Accessing this endpoint does not count against your REST API rate limit. + * @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. @@ -3167,9 +3636,10 @@ export interface paths { * * 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)." + * * 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/about-the-rest-api/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 closing down. 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"]; }; @@ -3178,7 +3648,8 @@ export interface paths { * 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"]; /** @@ -3566,7 +4037,7 @@ export interface paths { * * 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 endpoint 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"]; }; @@ -3668,8 +4139,8 @@ export interface paths { * 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. */ @@ -3928,6 +4399,8 @@ export interface paths { * 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 endpoint 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"]; }; @@ -3972,6 +4445,28 @@ export interface paths { */ get: operations["issues/check-user-can-be-assigned"]; }; + "/repos/{owner}/{repo}/attestations": { + /** + * Create an attestation + * @description Store an artifact attestation and associate it with a repository. + * + * The authenticated user must have write permission to the repository and, if using a fine-grained access token, the `attestations:write` permission is required. + * + * Artifact attestations are meant to be created using the [attest action](https://github.com/actions/attest). For more information, see our guide on [using artifact attestations to establish a build's provenance](https://docs.github.com/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds). + */ + post: operations["repos/create-attestation"]; + }; + "/repos/{owner}/{repo}/attestations/{subject_digest}": { + /** + * List attestations + * @description List a collection of artifact attestations with a given subject digest that are associated with a repository. + * + * The authenticated user making the request must have read access to the repository. In addition, when using a fine-grained access token the `attestations:read` permission is required. + * + * **Please note:** in order to offer meaningful security benefits, an attestation's signature and timestamps **must** be cryptographically verified, and the identity of the attestation signer **must** be validated. Attestations can be verified using the [GitHub CLI `attestation verify` command](https://cli.github.com/manual/gh_attestation_verify). For more information, see [our guide on how to use artifact attestations to establish a build's provenance](https://docs.github.com/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds). + */ + get: operations["repos/list-attestations"]; + }; "/repos/{owner}/{repo}/autolinks": { /** * Get all autolinks of a repository @@ -4039,9 +4534,11 @@ export interface paths { * * 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"]; /** @@ -4088,7 +4585,8 @@ export interface paths { * * 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"]; }; @@ -4099,7 +4597,8 @@ export interface paths { * * 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"]; /** @@ -4165,7 +4664,8 @@ export interface paths { * * 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"]; /** @@ -4283,7 +4783,8 @@ export interface paths { * 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. * @@ -4307,7 +4808,8 @@ export interface paths { * 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. */ @@ -4316,7 +4818,8 @@ export interface paths { * 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. */ @@ -4347,7 +4850,8 @@ export interface paths { * 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. */ @@ -4366,7 +4870,8 @@ export interface paths { * 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. */ @@ -4377,7 +4882,8 @@ export interface paths { * 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. */ @@ -4423,6 +4929,37 @@ export interface paths { */ patch: operations["code-scanning/update-alert"]; }; + "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/autofix": { + /** + * Get the status of an autofix for a code scanning alert + * @description Gets the status and description of an autofix for a 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. + */ + get: operations["code-scanning/get-autofix"]; + /** + * Create an autofix for a code scanning alert + * @description Creates an autofix for a code scanning alert. + * + * If a new autofix is to be created as a result of this request or is currently being generated, then this endpoint will return a 202 Accepted response. + * + * If an autofix already exists for a given alert, then this endpoint will return a 200 OK response. + * + * 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/create-autofix"]; + }; + "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/autofix/commits": { + /** + * Commit an autofix for a code scanning alert + * @description Commits an autofix for a code scanning alert. + * + * If an autofix is commited as a result of this request, then this endpoint will return a 201 Created response. + * + * 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. + */ + post: operations["code-scanning/commit-autofix"]; + }; "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/instances": { /** * List instances of a code scanning alert @@ -4446,8 +4983,8 @@ export interface paths { * 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. + * > [!WARNING] + * > **Closing down notice:** The `tool_name` field is closing down 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. */ @@ -4549,7 +5086,7 @@ export interface paths { * 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 `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/list-codeql-databases"]; }; @@ -4560,13 +5097,52 @@ export interface paths { * * 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 + * to [`application/zip`](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#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 `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-codeql-database"]; + /** + * Delete a CodeQL database + * @description Deletes a CodeQL database for a language in a repository. + * + * 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-codeql-database"]; + }; + "/repos/{owner}/{repo}/code-scanning/codeql/variant-analyses": { + /** + * Create a CodeQL variant analysis + * @description Creates a new CodeQL variant analysis, which will run a CodeQL query against one or more repositories. + * + * Get started by learning more about [running CodeQL queries at scale with Multi-Repository Variant Analysis](https://docs.github.com/code-security/codeql-for-vs-code/getting-started-with-codeql-for-vs-code/running-codeql-queries-at-scale-with-multi-repository-variant-analysis). + * + * Use the `owner` and `repo` parameters in the URL to specify the controller repository that + * will be used for running GitHub Actions workflows and storing the results of the CodeQL variant analysis. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + post: operations["code-scanning/create-variant-analysis"]; + }; + "/repos/{owner}/{repo}/code-scanning/codeql/variant-analyses/{codeql_variant_analysis_id}": { + /** + * Get the summary of a CodeQL variant analysis + * @description Gets the summary of a CodeQL variant analysis. + * + * 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-variant-analysis"]; + }; + "/repos/{owner}/{repo}/code-scanning/codeql/variant-analyses/{codeql_variant_analysis_id}/repos/{repo_owner}/{repo_name}": { + /** + * Get the analysis status of a repository in a CodeQL variant analysis + * @description Gets the analysis status of a repository in a CodeQL variant analysis. + * + * 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-variant-analysis-repo-task"]; }; "/repos/{owner}/{repo}/code-scanning/default-setup": { /** @@ -4619,6 +5195,8 @@ export interface paths { * 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. + * + * This endpoint is limited to 1,000 requests per hour for each user or app installation calling it. */ post: operations["code-scanning/upload-sarif"]; }; @@ -4630,6 +5208,17 @@ export interface paths { */ get: operations["code-scanning/get-sarif"]; }; + "/repos/{owner}/{repo}/code-security-configuration": { + /** + * Get the code security configuration associated with a repository + * @description Get the code security configuration that manages a repository's code security settings. + * + * 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` scope to use this endpoint. + */ + get: operations["code-security/get-configuration-for-repository"]; + }; "/repos/{owner}/{repo}/codeowners/errors": { /** * List CODEOWNERS errors @@ -4710,8 +5299,6 @@ export interface paths { * @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. */ get: operations["codespaces/get-repo-public-key"]; @@ -4768,7 +5355,7 @@ export interface paths { 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)." + * @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/using-the-rest-api/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)." * @@ -4809,7 +5396,8 @@ export interface paths { * - 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. * @@ -4887,7 +5475,8 @@ export interface paths { "/repos/{owner}/{repo}/comments/{comment_id}/reactions/{reaction_id}": { /** * 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`. + * @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). */ @@ -4906,6 +5495,7 @@ export interface paths { * | `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. | + * | `verified_at` | `string` | The date the signature was verified by GitHub. | * * These are the possible values for `reason` in the `verification` object: * @@ -4953,7 +5543,7 @@ export interface paths { * 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/using-the-rest-api/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)." * @@ -4978,7 +5568,8 @@ export interface paths { * 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. * @@ -4996,6 +5587,7 @@ export interface paths { * | `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. | + * | `verified_at` | `string` | The date the signature was verified by GitHub. | * * These are the possible values for `reason` in the `verification` object: * @@ -5022,7 +5614,8 @@ export interface paths { * 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. * @@ -5035,7 +5628,8 @@ export interface paths { * 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. */ @@ -5101,7 +5695,7 @@ export interface paths { * * 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 list of changed files is only shown on the first page of results, and it includes up to 300 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)." @@ -5116,6 +5710,7 @@ export interface paths { * | `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. | + * | `verified_at` | `string` | The date the signature was verified by GitHub. | * * These are the possible values for `reason` in the `verification` object: * @@ -5171,7 +5766,8 @@ export interface paths { * 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. */ @@ -5186,7 +5782,8 @@ export interface paths { * * 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"]; }; @@ -5415,7 +6012,8 @@ export interface paths { "/repos/{owner}/{repo}/environments/{environment_name}": { /** * 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)." + * @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. * @@ -5426,9 +6024,11 @@ export interface paths { * 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. */ @@ -5507,7 +6107,9 @@ export interface paths { "/repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules/apps": { /** * 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. + * @description Gets all custom deployment protection rule integrations that are available for an environment. + * + * The authenticated user must have admin or owner permissions to the repository to 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)." * @@ -5643,7 +6245,8 @@ export interface paths { "/repos/{owner}/{repo}/events": { /** * 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. + * @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"]; }; @@ -5654,9 +6257,11 @@ export interface paths { * 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"]; }; @@ -5693,6 +6298,7 @@ export interface paths { * | `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. | + * | `verified_at` | `string` | The date the signature was verified by GitHub. | * * These are the possible values for `reason` in the `verification` object: * @@ -5731,6 +6337,7 @@ export interface paths { * | `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. | + * | `verified_at` | `string` | The date the signature was verified by GitHub. | * * These are the possible values for `reason` in the `verification` object: * @@ -5759,7 +6366,8 @@ export interface paths { * * 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`. */ @@ -5770,7 +6378,8 @@ export interface paths { * 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"]; }; @@ -5808,6 +6417,7 @@ export interface paths { * | `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. | + * | `verified_at` | `string` | The date the signature was verified by GitHub. | * * These are the possible values for `reason` in the `verification` object: * @@ -5842,6 +6452,7 @@ export interface paths { * | `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. | + * | `verified_at` | `string` | The date the signature was verified by GitHub. | * * These are the possible values for `reason` in the `verification` object: * @@ -5881,8 +6492,8 @@ export interface paths { * * 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"]; }; @@ -5905,7 +6516,12 @@ export interface paths { * @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"]; - /** Delete a repository webhook */ + /** + * Delete a repository webhook + * @description Delete a webhook for an organization. + * + * The authenticated user must be a repository owner, or have admin access in the repository, to delete the webhook. + */ delete: operations["repos/delete-webhook"]; /** * Update a repository webhook @@ -5962,7 +6578,8 @@ export interface paths { * 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"]; }; @@ -5972,7 +6589,8 @@ export interface paths { * @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] + * > **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down 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** * @@ -6015,7 +6633,8 @@ export interface paths { * 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] + * > **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down 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"]; /** @@ -6023,7 +6642,8 @@ export interface paths { * @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] + * > **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down 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"]; /** @@ -6036,7 +6656,8 @@ export interface paths { * 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] + * > **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down 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"]; }; @@ -6048,7 +6669,8 @@ export interface paths { * * 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] + * > **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down 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"]; }; @@ -6059,7 +6681,8 @@ export interface paths { * @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). + * > [!WARNING] + * > **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down 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"]; }; @@ -6069,7 +6692,8 @@ export interface paths { * @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] + * > **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down 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"]; }; @@ -6083,7 +6707,8 @@ export interface paths { * 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] + * > **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down 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"]; }; @@ -6131,10 +6756,8 @@ export interface paths { * 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)." * @@ -6148,7 +6771,7 @@ export interface paths { * 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)" + * 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/using-the-rest-api/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)." @@ -6222,7 +6845,8 @@ export interface paths { "/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions/{reaction_id}": { /** * 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`. + * @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). */ @@ -6252,10 +6876,8 @@ export interface paths { * 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)." * @@ -6267,7 +6889,7 @@ export interface paths { get: operations["issues/get"]; /** * Update an issue - * @description Issue owners and users with push access can edit an issue. + * @description Issue owners and users with push access or Triage role 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)." * @@ -6322,7 +6944,7 @@ export interface paths { * * 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)" + * For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/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)." @@ -6399,12 +7021,65 @@ export interface paths { "/repos/{owner}/{repo}/issues/{issue_number}/reactions/{reaction_id}": { /** * 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`. + * @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: operations["reactions/delete-for-issue"]; }; + "/repos/{owner}/{repo}/issues/{issue_number}/sub_issue": { + /** + * Remove sub-issue + * @description You can use the REST API to remove a sub-issue from an issue. + * Removing 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/using-the-rest-api/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 a specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + */ + delete: operations["issues/remove-sub-issue"]; + }; + "/repos/{owner}/{repo}/issues/{issue_number}/sub_issues": { + /** + * List sub-issues + * @description You can use the REST API to list the sub-issues on 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`. + */ + get: operations["issues/list-sub-issues"]; + /** + * Add sub-issue + * @description You can use the REST API to add sub-issues to issues. + * + * 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/using-the-rest-api/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`. + */ + post: operations["issues/add-sub-issue"]; + }; + "/repos/{owner}/{repo}/issues/{issue_number}/sub_issues/priority": { + /** + * Reprioritize sub-issue + * @description You can use the REST API to reprioritize a sub-issue to a different position in the parent list. + */ + patch: operations["issues/reprioritize-sub-issue"]; + }; "/repos/{owner}/{repo}/issues/{issue_number}/timeline": { /** * List timeline events for an issue @@ -6714,7 +7389,7 @@ export interface paths { * * 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/using-the-rest-api/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)." * @@ -6786,7 +7461,8 @@ export interface paths { "/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions/{reaction_id}": { /** * 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.` + * @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). */ @@ -6809,7 +7485,7 @@ export interface paths { * * 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/using-the-rest-api/getting-started-with-the-rest-api#media-types) 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)." * @@ -6864,9 +7540,9 @@ export interface paths { * * 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 closing down. 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)" + * 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/using-the-rest-api/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)." @@ -6883,7 +7559,7 @@ export interface paths { * 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)" + * 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/using-the-rest-api/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)." @@ -6916,8 +7592,8 @@ export interface paths { * 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)." * @@ -6937,7 +7613,7 @@ 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/using-the-rest-api/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"]; }; @@ -6975,11 +7651,12 @@ export interface paths { * 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/using-the-rest-api/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. + * > [!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. * @@ -7049,9 +7726,8 @@ export interface paths { * 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)." * @@ -7080,6 +7756,7 @@ export interface paths { /** * 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. + * Note: If making a request on behalf of a GitHub App you must also have permissions to write the contents of the head repository. */ put: operations["pulls/update-branch"]; }; @@ -7119,14 +7796,20 @@ export interface paths { * 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/using-the-rest-api/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"]; }; "/repos/{owner}/{repo}/releases/assets/{asset_id}": { /** * 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. + * @description To download the asset's binary content: + * + * - If within a browser, fetch the location specified in the `browser_download_url` key provided in the response. + * - Alternatively, set the `Accept` header of the request to + * [`application/octet-stream`](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#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"]; /** Delete a release asset */ @@ -7165,9 +7848,8 @@ export interface paths { * 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"]; /** @@ -7223,7 +7905,8 @@ export interface paths { "/repos/{owner}/{repo}/releases/{release_id}/reactions/{reaction_id}": { /** * 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`. + * @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). */ @@ -7271,6 +7954,9 @@ export interface paths { /** * Get a repository ruleset * @description Get a ruleset for a repository. + * + * **Note:** To prevent leaking sensitive information, the `bypass_actors` property is only returned if the user + * making the API request has write access to the ruleset. */ get: operations["repos/get-repo-ruleset"]; /** @@ -7326,6 +8012,26 @@ export interface paths { */ get: operations["secret-scanning/list-locations-for-alert"]; }; + "/repos/{owner}/{repo}/secret-scanning/push-protection-bypasses": { + /** + * Create a push protection bypass + * @description Creates a bypass for a previously push protected secret. + * + * The authenticated user must be the original author of the committed secret. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + post: operations["secret-scanning/create-push-protection-bypass"]; + }; + "/repos/{owner}/{repo}/secret-scanning/scan-history": { + /** + * Get secret scanning scan history for a repository + * @description Lists the latest default incremental and backfill scans by type for a repository. Scans from Copilot Secret Scanning are not included. + * + * 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-scan-history"]; + }; "/repos/{owner}/{repo}/security-advisories": { /** * List repository security advisories @@ -7396,7 +8102,8 @@ export interface paths { * 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"]; }; @@ -7414,11 +8121,10 @@ export interface paths { "/repos/{owner}/{repo}/stats/code_frequency": { /** * Get the weekly commit activity - * @description - * Returns a weekly aggregate of the number of additions and deletions pushed to a repository. + * @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. + * > [!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"]; }; @@ -7440,7 +8146,8 @@ export interface paths { * * `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"]; }; @@ -7507,23 +8214,35 @@ export interface paths { }; "/repos/{owner}/{repo}/tags/protection": { /** - * List tag protection states for a repository - * @description This returns the tag protection states of a repository. + * Closing down - List tag protection states for a repository + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** This operation is closing down and will be removed after August 30, 2024. Use the "[Repository Rulesets](https://docs.github.com/rest/repos/rules#get-all-repository-rulesets)" endpoint instead. + * + * This returns the tag protection states of a repository. * * This information is only available to repository administrators. */ get: operations["repos/list-tag-protection"]; /** - * Create a tag protection state for a repository - * @description This creates a tag protection state for a repository. + * Closing down - Create a tag protection state for a repository + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** This operation is closing down and will be removed after August 30, 2024. Use the "[Repository Rulesets](https://docs.github.com/rest/repos/rules#create-a-repository-ruleset)" endpoint instead. + * + * This creates a tag protection state for a repository. * This endpoint is only available to repository administrators. */ post: operations["repos/create-tag-protection"]; }; "/repos/{owner}/{repo}/tags/protection/{tag_protection_id}": { /** - * Delete a tag protection state for a repository - * @description This deletes a tag protection state for a repository. + * Closing down - Delete a tag protection state for a repository + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** This operation is closing down and will be removed after August 30, 2024. Use the "[Repository Rulesets](https://docs.github.com/rest/repos/rules#delete-a-repository-ruleset)" endpoint instead. + * + * This deletes a tag protection state for a repository. * This endpoint is only available to repository administrators. */ delete: operations["repos/delete-tag-protection"]; @@ -7534,7 +8253,9 @@ export interface paths { * @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. + * + * > [!NOTE] + * > For private repositories, these links are temporary and expire after five minutes. */ get: operations["repos/download-tarball-archive"]; }; @@ -7616,7 +8337,8 @@ export interface paths { * `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"]; }; @@ -7694,7 +8416,8 @@ export interface paths { * * 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"]; }; @@ -7764,13 +8487,15 @@ export interface paths { /** * 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. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down 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"]; /** * 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. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down 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. * @@ -7780,11 +8505,13 @@ export interface paths { /** * 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. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down 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`. + * > [!NOTE] + * > With nested teams, the `privacy` for parent teams cannot be `secret`. */ patch: operations["teams/update-legacy"]; }; @@ -7792,7 +8519,8 @@ export interface paths { /** * 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. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down 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. * @@ -7802,11 +8530,12 @@ export interface paths { /** * 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. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down 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)." + * 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/using-the-rest-api/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. */ @@ -7816,7 +8545,8 @@ export interface paths { /** * 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. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down 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. * @@ -7826,7 +8556,8 @@ export interface paths { /** * 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. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down 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. * @@ -7836,7 +8567,8 @@ export interface paths { /** * 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. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down 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. * @@ -7848,7 +8580,8 @@ export interface paths { /** * 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. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down 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. * @@ -7858,11 +8591,12 @@ export interface paths { /** * 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. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down 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)." + * 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/using-the-rest-api/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. */ @@ -7872,7 +8606,8 @@ export interface paths { /** * 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. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down 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. * @@ -7882,7 +8617,8 @@ export interface paths { /** * 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. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down 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. * @@ -7892,7 +8628,8 @@ export interface paths { /** * 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. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down 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. * @@ -7904,7 +8641,8 @@ export interface paths { /** * 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. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down 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). * @@ -7914,7 +8652,8 @@ export interface paths { /** * 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. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down 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). * @@ -7928,7 +8667,8 @@ export interface paths { /** * 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. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down 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). * @@ -7938,7 +8678,8 @@ export interface paths { /** * 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. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down 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). * @@ -7952,7 +8693,8 @@ export interface paths { /** * 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. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down 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`. */ @@ -7962,7 +8704,8 @@ export interface paths { /** * 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. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down 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. */ @@ -7972,7 +8715,7 @@ export interface paths { /** * Get team member (Legacy) * @deprecated - * @description The "Get team member" endpoint (described below) is deprecated. + * @description The "Get team member" endpoint (described below) is closing down. * * 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. * @@ -7982,7 +8725,7 @@ export interface paths { /** * Add team member (Legacy) * @deprecated - * @description The "Add team member" endpoint (described below) is deprecated. + * @description The "Add team member" endpoint (described below) is closing down. * * 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. * @@ -7990,7 +8733,8 @@ export interface paths { * * 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)." */ @@ -7998,7 +8742,7 @@ export interface paths { /** * Remove team member (Legacy) * @deprecated - * @description The "Remove team member" endpoint (described below) is deprecated. + * @description The "Remove team member" endpoint (described below) is closing down. * * 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. * @@ -8006,7 +8750,8 @@ export interface paths { * * 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"]; }; @@ -8014,7 +8759,8 @@ export interface paths { /** * 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. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down 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. * @@ -8029,13 +8775,15 @@ export interface paths { /** * 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. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down 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/)." + * > [!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. * @@ -8045,13 +8793,15 @@ export interface paths { /** * 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. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down 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/)." + * > [!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"]; }; @@ -8059,7 +8809,8 @@ export interface paths { /** * 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. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down 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. */ @@ -8069,7 +8820,8 @@ export interface paths { /** * 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. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down 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. */ @@ -8077,7 +8829,8 @@ export interface paths { /** * 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. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down 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. */ @@ -8085,7 +8838,8 @@ export interface paths { /** * 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. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down 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. */ @@ -8095,7 +8849,8 @@ export interface paths { /** * 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. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down 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"]; }; @@ -8103,17 +8858,20 @@ export interface paths { /** * Check team permissions for a repository (Legacy) * @deprecated - * @description **Note**: Repositories inherited through a parent team will also be checked. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down 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. + * > [!NOTE] + * > 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 `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/using-the-rest-api/getting-started-with-the-rest-api#media-types/) via the `Accept` header: */ get: operations["teams/check-permissions-for-repo-legacy"]; /** * 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. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down 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. * @@ -8123,7 +8881,8 @@ export interface paths { /** * 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. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down 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. */ @@ -8133,7 +8892,8 @@ export interface paths { /** * 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. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down 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"]; }; @@ -8493,11 +9253,15 @@ export interface paths { /** * 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. + * + * This endpoint only works for PATs (classic) with the `repo` scope. */ put: operations["apps/add-repo-to-installation-for-authenticated-user"]; /** * 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`. + * + * This endpoint only works for PATs (classic) with the `repo` scope. */ delete: operations["apps/remove-repo-from-installation-for-authenticated-user"]; }; @@ -8523,10 +9287,8 @@ export interface paths { * 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)." * @@ -8680,6 +9442,9 @@ export interface paths { * @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. + * + * > [!NOTE] + * > Requests using a fine-grained access token will receive a `200 Success` response with an empty list. */ get: operations["orgs/list-for-authenticated-user"]; }; @@ -8688,7 +9453,7 @@ export interface paths { * 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. For more information, 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"]; }; @@ -8697,14 +9462,14 @@ export interface paths { * 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. For more information, 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"]; /** * 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. For more information, 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"]; }; @@ -8717,7 +9482,7 @@ export interface paths { * - 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. For more information, 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"]; }; @@ -8726,7 +9491,7 @@ export interface paths { * 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. For more information, 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"]; }; @@ -8735,7 +9500,7 @@ export interface paths { * 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. For more information, 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"]; /** @@ -8744,7 +9509,7 @@ export interface paths { * * 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. For more information, 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"]; }; @@ -8757,7 +9522,7 @@ export interface paths { * - 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. For more information, 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"]; }; @@ -8908,6 +9673,17 @@ export interface paths { */ get: operations["teams/list-for-authenticated-user"]; }; + "/user/{account_id}": { + /** + * Get a user using their ID + * @description Provides publicly available information about someone with a GitHub account. This method takes their durable user `ID` instead of their `login`, which can change over time. + * + * 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)". + */ + get: operations["users/get-by-id"]; + }; "/users": { /** * List users @@ -8928,6 +9704,17 @@ export interface paths { */ get: operations["users/get-by-username"]; }; + "/users/{username}/attestations/{subject_digest}": { + /** + * List attestations + * @description List a collection of artifact attestations with a given subject digest that are associated with repositories owned by a user. + * + * The collection of attestations returned by this endpoint is filtered according to the authenticated user's permissions; if the authenticated user cannot read a repository, the attestations associated with that repository will not be included in the response. In addition, when using a fine-grained access token the `attestations:read` permission is required. + * + * **Please note:** in order to offer meaningful security benefits, an attestation's signature and timestamps **must** be cryptographically verified, and the identity of the attestation signer **must** be validated. Attestations can be verified using the [GitHub CLI `attestation verify` command](https://cli.github.com/manual/gh_attestation_verify). For more information, see [our guide on how to use artifact attestations to establish a build's provenance](https://docs.github.com/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds). + */ + get: operations["users/list-attestations"]; + }; "/users/{username}/docker/conflicts": { /** * Get list of conflicting packages during Docker migration for user @@ -8940,7 +9727,10 @@ export interface paths { "/users/{username}/events": { /** * 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. + * @description If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events. _Optional_: use the fine-grained token with following permission set to view private events: "Events" user permissions (read). + * + * > [!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-events-for-authenticated-user"]; }; @@ -8948,11 +9738,18 @@ export interface paths { /** * 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. + * + * > [!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-org-events-for-authenticated-user"]; }; "/users/{username}/events/public": { - /** List public events for a user */ + /** + * List public events for a user + * @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-public-events-for-user"]; }; "/users/{username}/followers": { @@ -9028,7 +9825,7 @@ export interface paths { * 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. For more information, 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"]; }; @@ -9037,7 +9834,7 @@ export interface paths { * 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. For more information, 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"]; /** @@ -9046,7 +9843,7 @@ export interface paths { * * 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. For more information, 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"]; }; @@ -9061,7 +9858,7 @@ export interface paths { * * 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. For more information, 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"]; }; @@ -9070,7 +9867,7 @@ export interface paths { * 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. For more information, 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"]; }; @@ -9079,7 +9876,7 @@ export interface paths { * 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. For more information, 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"]; /** @@ -9088,7 +9885,7 @@ export interface paths { * * 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. For more information, 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"]; }; @@ -9103,7 +9900,7 @@ export interface paths { * * 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. For more information, 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"]; }; @@ -9117,12 +9914,20 @@ export interface paths { "/users/{username}/received_events": { /** * 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. + * @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. + * + * > [!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-received-events-for-user"]; }; "/users/{username}/received_events/public": { - /** List public events received by a user */ + /** + * List public events received by a user + * @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-received-public-events-for-user"]; }; "/users/{username}/repos": { @@ -9257,6 +10062,22 @@ export interface paths { */ get: operations["repos/compare-commits"]; }; + "/orgs/{org}/organization-fine-grained-permissions": { + /** + * 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. + */ + get: operations["orgs/list-organization-fine-grained-permissions"]; + }; } export type webhooks = Record; @@ -9367,6 +10188,20 @@ export interface components { /** @description The functions in the package that are affected by the vulnerability. */ vulnerable_functions: readonly string[] | null; }; + "cvss-severities": { + cvss_v3?: { + /** @description The CVSS 3 vector string. */ + vector_string: string | null; + /** @description The CVSS 3 score. */ + score: number | null; + } | null; + cvss_v4?: { + /** @description The CVSS 4 vector string. */ + vector_string: string | null; + /** @description The CVSS 4 score. */ + score: number | null; + } | null; + } | null; /** * Simple User * @description A GitHub user. @@ -9376,7 +10211,10 @@ export interface components { email?: string | null; /** @example octocat */ login: string; - /** @example 1 */ + /** + * Format: int64 + * @example 1 + */ id: number; /** @example MDQ6VXNlcjE= */ node_id: string; @@ -9435,6 +10273,8 @@ export interface components { site_admin: boolean; /** @example "2020-07-09T00:17:55Z" */ starred_at?: string; + /** @example public */ + user_view_type?: string; }; /** * @description The type of credit the user is receiving. @@ -9534,6 +10374,7 @@ export interface components { /** @description The CVSS score. */ score: number | null; } | null; + cvss_severities?: components["schemas"]["cvss-severities"]; cwes: | { /** @description The Common Weakness Enumeration (CWE) identifier. */ @@ -9542,6 +10383,10 @@ export interface components { name: string; }[] | null; + epss?: { + percentage?: number; + percentile?: number; + } | null; /** @description The users who contributed to the advisory. */ credits: | readonly { @@ -9578,7 +10423,10 @@ export interface components { email?: string | null; /** @example octocat */ login: string; - /** @example 1 */ + /** + * Format: int64 + * @example 1 + */ id: number; /** @example MDQ6VXNlcjE= */ node_id: string; @@ -9637,6 +10485,8 @@ export interface components { site_admin: boolean; /** @example "2020-07-09T00:17:55Z" */ starred_at?: string; + /** @example public */ + user_view_type?: string; } | null; /** * GitHub app @@ -9655,6 +10505,8 @@ export interface components { slug?: string; /** @example MDExOkludGVncmF0aW9uMQ== */ node_id: string; + /** @example "Iv1.25b5d1e65ffc4022" */ + client_id?: string; owner: components["schemas"]["nullable-simple-user"]; /** * @description The name of the GitHub app @@ -9711,8 +10563,6 @@ export interface components { * @example 5 */ installations_count?: number; - /** @example "Iv1.25b5d1e65ffc4022" */ - client_id?: string; /** @example "1d4b2097ac622ba702d19de498f005747a8b21d3" */ client_secret?: string; /** @example "6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b" */ @@ -9808,6 +10658,12 @@ export interface components { * @example 123 */ repository_id: number | null; + /** + * Format: date-time + * @description Time when the webhook delivery was throttled. + * @example 2021-05-12T20:33:44Z + */ + throttled_at?: string | null; }; /** * Scim Error @@ -9898,6 +10754,12 @@ export interface components { * @example 123 */ repository_id: number | null; + /** + * Format: date-time + * @description Time when the webhook delivery was throttled. + * @example 2021-05-12T20:33:44Z + */ + throttled_at?: string | null; /** * @description The URL target of the delivery. * @example https://www.example.com @@ -10143,7 +11005,7 @@ export interface components { */ organization_custom_properties?: "read" | "write" | "admin"; /** - * @description The level of permission to grant the access token for managing access to GitHub Copilot for members of an organization with a Copilot Business subscription. This property is in beta and is subject to change. + * @description The level of permission to grant the access token for managing access to GitHub Copilot for members of an organization with a Copilot Business subscription. This property is in public preview and is subject to change. * @enum {string} */ organization_copilot_seat_management?: "write"; @@ -10178,7 +11040,7 @@ export interface components { */ organization_plan?: "read"; /** - * @description The level of permission to grant the access token to manage organization projects and projects beta (where available). + * @description The level of permission to grant the access token to manage organization projects and projects public preview (where available). * @enum {string} */ organization_projects?: "read" | "write" | "admin"; @@ -10337,6 +11199,7 @@ export interface components { */ repository: { /** + * Format: int64 * @description Unique identifier of the repository * @example 42 */ @@ -10628,7 +11491,7 @@ export interface components { 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. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -10741,6 +11604,7 @@ export interface components { * @description The authorization for an OAuth app, GitHub App, or a Personal Access Token. */ authorization: { + /** Format: int64 */ id: number; /** Format: uri */ url: string; @@ -11212,184 +12076,156 @@ export interface components { /** Format: uri */ html_url: string | null; }; - /** - * Copilot Usage Metrics - * @description Summary of Copilot usage. - */ - "copilot-usage-metrics": { + /** @description A code security configuration */ + "code-security-configuration": { + /** @description The ID of the code security configuration */ + id?: number; + /** @description The name of the code security configuration. Must be unique within the organization. */ + name?: string; /** - * Format: date - * @description The date for which the usage metrics are reported, in `YYYY-MM-DD` format. + * @description The type of the code security configuration. + * @enum {string} */ - day: string; - /** @description The total number of Copilot code completion suggestions shown to users. */ - total_suggestions_count?: number; - /** @description The total number of Copilot code completion suggestions accepted by users. */ - total_acceptances_count?: number; - /** @description The total number of lines of code completions suggested by Copilot. */ - total_lines_suggested?: number; - /** @description The total number of lines of code completions accepted by users. */ - total_lines_accepted?: number; - /** @description The total number of users who were shown Copilot code completion suggestions during the day specified. */ - total_active_users?: number; - /** @description The total instances of users who accepted code suggested by Copilot Chat in the IDE (panel and inline). */ - total_chat_acceptances?: number; - /** @description The total number of chat turns (prompt and response pairs) sent between users and Copilot Chat in the IDE. */ - total_chat_turns?: number; - /** @description The total number of users who interacted with Copilot Chat in the IDE during the day specified. */ - total_active_chat_users?: number; - /** @description Breakdown of Copilot code completions usage by language and editor */ - breakdown: - | { - /** @description The language in which Copilot suggestions were shown to users in the specified editor. */ - language?: string; - /** @description The editor in which Copilot suggestions were shown to users for the specified language. */ - editor?: string; - /** @description The number of Copilot suggestions shown to users in the editor specified during the day specified. */ - suggestions_count?: number; - /** @description The number of Copilot suggestions accepted by users in the editor specified during the day specified. */ - acceptances_count?: number; - /** @description The number of lines of code suggested by Copilot in the editor specified during the day specified. */ - lines_suggested?: number; - /** @description The number of lines of code accepted by users in the editor specified during the day specified. */ - lines_accepted?: number; - /** @description The number of users who were shown Copilot completion suggestions in the editor specified during the day specified. */ - active_users?: number; - [key: string]: unknown; - }[] - | null; - }; - /** @description The security alert number. */ - readonly "alert-number": number; - /** @description Details for the vulnerable package. */ - readonly "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"]; + target_type?: "global" | "organization" | "enterprise"; + /** @description A description of the code security configuration */ + description?: string; /** - * @description The severity of the vulnerability. + * @description The enablement status of GitHub Advanced Security * @enum {string} */ - readonly severity: "low" | "medium" | "high" | "critical"; - /** @description Conditions that identify vulnerable versions of this vulnerability's package. */ - readonly vulnerable_version_range: string; - /** @description Details pertaining to the package version that patches this vulnerability. */ - readonly first_patched_version: { - /** @description The package version that patches this vulnerability. */ - readonly identifier: string; - } | null; - }; - /** @description Details for the GitHub Security Advisory. */ - readonly "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. */ - readonly cve_id: string | null; - /** @description A short, plain text summary of the advisory. */ - readonly summary: string; - /** @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"][]; + advanced_security?: "enabled" | "disabled"; /** - * @description The severity of the advisory. + * @description The enablement status of Dependency Graph * @enum {string} */ - readonly severity: "low" | "medium" | "high" | "critical"; - /** @description Details for the advisory pertaining to the Common Vulnerability Scoring System. */ - readonly cvss: { - /** @description The overall CVSS score of the advisory. */ - readonly score: number; - /** @description The full CVSS vector string for the advisory. */ - readonly vector_string: string | null; + dependency_graph?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Automatic dependency submission + * @enum {string} + */ + dependency_graph_autosubmit_action?: "enabled" | "disabled" | "not_set"; + /** @description Feature options for Automatic dependency submission */ + dependency_graph_autosubmit_action_options?: { + /** @description Whether to use runners labeled with 'dependency-submission' or standard GitHub runners. */ + labeled_runners?: boolean; }; - /** @description Details for the advisory pertaining to Common Weakness Enumeration. */ - readonly cwes: readonly { - /** @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 { - /** - * @description The type of advisory identifier. - * @enum {string} - */ - readonly type: "CVE" | "GHSA"; - /** @description The value of the advisory identifer. */ - readonly value: string; - }[]; - /** @description Links to additional advisory information. */ - readonly references: readonly { + /** + * @description The enablement status of Dependabot alerts + * @enum {string} + */ + dependabot_alerts?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Dependabot security updates + * @enum {string} + */ + dependabot_security_updates?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of code scanning default setup + * @enum {string} + */ + code_scanning_default_setup?: "enabled" | "disabled" | "not_set"; + /** @description Feature options for code scanning default setup */ + code_scanning_default_setup_options?: { /** - * Format: uri - * @description The URL of the reference. + * @description Whether to use labeled runners or standard GitHub runners. + * @enum {string|null} */ - readonly url: string; - }[]; + runner_type?: "standard" | "labeled" | "not_set" | null; + /** @description The label of the runner to use for code scanning when runner_type is 'labeled'. */ + runner_label?: string | null; + } | null; /** - * Format: date-time - * @description The time that the advisory was published in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @description The enablement status of secret scanning + * @enum {string} */ - readonly published_at: string; + secret_scanning?: "enabled" | "disabled" | "not_set"; /** - * Format: date-time - * @description The time that the advisory was last modified in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @description The enablement status of secret scanning push protection + * @enum {string} */ - readonly updated_at: string; + secret_scanning_push_protection?: "enabled" | "disabled" | "not_set"; /** - * Format: date-time - * @description The time that the advisory was withdrawn in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @description The enablement status of secret scanning delegated bypass + * @enum {string} */ - readonly withdrawn_at: string | null; + secret_scanning_delegated_bypass?: "enabled" | "disabled" | "not_set"; + /** @description Feature options for secret scanning delegated bypass */ + secret_scanning_delegated_bypass_options?: { + /** @description The bypass reviewers for secret scanning delegated bypass */ + reviewers?: { + /** @description The ID of the team or role selected as a bypass reviewer */ + reviewer_id: number; + /** + * @description The type of the bypass reviewer + * @enum {string} + */ + reviewer_type: "TEAM" | "ROLE"; + }[]; + }; + /** + * @description The enablement status of secret scanning validity checks + * @enum {string} + */ + secret_scanning_validity_checks?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning non-provider patterns + * @enum {string} + */ + secret_scanning_non_provider_patterns?: + | "enabled" + | "disabled" + | "not_set"; + /** + * @description The enablement status of private vulnerability reporting + * @enum {string} + */ + private_vulnerability_reporting?: "enabled" | "disabled" | "not_set"; + /** + * @description The enforcement status for a security configuration + * @enum {string} + */ + enforcement?: "enforced" | "unenforced"; + /** + * Format: uri + * @description The URL of the configuration + */ + url?: string; + /** + * Format: uri + * @description The URL of the configuration + */ + html_url?: string; + /** Format: date-time */ + created_at?: string; + /** Format: date-time */ + updated_at?: string; }; - /** - * Format: uri - * @description The REST API URL of the alert resource. - */ - readonly "alert-url": string; - /** - * Format: uri - * @description The GitHub URL of the alert resource. - */ - readonly "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; - /** - * 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; - /** - * 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; - /** - * 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; - /** - * 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; + /** @description Feature options for code scanning default setup */ + "code-scanning-default-setup-options": { + /** + * @description Whether to use labeled runners or standard GitHub runners. + * @enum {string} + */ + runner_type?: "standard" | "labeled" | "not_set"; + /** @description The label of the runner to use for code scanning default setup when runner_type is 'labeled'. */ + runner_label?: string | null; + } | null; + /** @description A list of default code security configurations */ + "code-security-default-configurations": { + /** + * @description The visibility of newly created repositories for which the code security configuration will be applied to by default + * @enum {unknown} + */ + default_for_new_repos?: "public" | "private_and_internal" | "all"; + configuration?: components["schemas"]["code-security-configuration"]; + }[]; /** * Simple Repository * @description A GitHub repository. */ "simple-repository": { /** + * Format: int64 * @description A unique identifier of the repository. * @example 1296269 */ @@ -11625,6 +12461,149 @@ export interface components { */ hooks_url: string; }; + /** @description Repositories associated with a code security configuration and attachment status */ + "code-security-configuration-repositories": { + /** + * @description The attachment status of the code security configuration on the repository. + * @enum {string} + */ + status?: + | "attached" + | "attaching" + | "detached" + | "removed" + | "enforced" + | "failed" + | "updating" + | "removed_by_enterprise"; + repository?: components["schemas"]["simple-repository"]; + }; + /** @description The security alert number. */ + readonly "alert-number": number; + /** @description Details for the vulnerable package. */ + readonly "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"]; + /** + * @description The severity of the vulnerability. + * @enum {string} + */ + readonly severity: "low" | "medium" | "high" | "critical"; + /** @description Conditions that identify vulnerable versions of this vulnerability's package. */ + readonly vulnerable_version_range: string; + /** @description Details pertaining to the package version that patches this vulnerability. */ + readonly first_patched_version: { + /** @description The package version that patches this vulnerability. */ + readonly identifier: string; + } | null; + }; + /** @description Details for the GitHub Security Advisory. */ + readonly "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. */ + readonly cve_id: string | null; + /** @description A short, plain text summary of the advisory. */ + readonly summary: string; + /** @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"][]; + /** + * @description The severity of the advisory. + * @enum {string} + */ + readonly severity: "low" | "medium" | "high" | "critical"; + /** @description Details for the advisory pertaining to the Common Vulnerability Scoring System. */ + readonly cvss: { + /** @description The overall CVSS score of the advisory. */ + readonly score: number; + /** @description The full CVSS vector string for the advisory. */ + readonly vector_string: string | null; + }; + readonly cvss_severities?: components["schemas"]["cvss-severities"]; + /** @description Details for the advisory pertaining to Common Weakness Enumeration. */ + readonly cwes: readonly { + /** @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 { + /** + * @description The type of advisory identifier. + * @enum {string} + */ + readonly type: "CVE" | "GHSA"; + /** @description The value of the advisory identifer. */ + readonly value: string; + }[]; + /** @description Links to additional advisory information. */ + readonly references: readonly { + /** + * Format: uri + * @description The URL of the reference. + */ + readonly url: string; + }[]; + /** + * Format: date-time + * @description The time that the advisory was published in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + readonly published_at: string; + /** + * Format: date-time + * @description The time that the advisory was last modified in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + readonly updated_at: string; + /** + * Format: date-time + * @description The time that the advisory was withdrawn in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + readonly withdrawn_at: string | null; + }; + /** + * Format: uri + * @description The REST API URL of the alert resource. + */ + readonly "alert-url": string; + /** + * Format: uri + * @description The GitHub URL of the alert resource. + */ + readonly "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; + /** + * 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; + /** + * 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; + /** + * 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; + /** + * 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; /** @description A Dependabot alert. */ "dependabot-alert-with-repository": { number: components["schemas"]["alert-number"]; @@ -11712,7 +12691,7 @@ export interface components { 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)." + * For a list of built-in patterns, see "[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)." */ secret_type_display_name?: string; /** @description The secret that was detected. */ @@ -11726,6 +12705,16 @@ export interface components { * @description The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ push_protection_bypassed_at?: string | null; + push_protection_bypass_request_reviewer?: components["schemas"]["nullable-simple-user"]; + /** @description An optional comment when reviewing a push protection bypass. */ + push_protection_bypass_request_reviewer_comment?: string | null; + /** @description An optional comment when requesting a push protection bypass. */ + push_protection_bypass_request_comment?: string | null; + /** + * Format: uri + * @description The URL to a push protection bypass request. + */ + push_protection_bypass_request_html_url?: string | null; /** @description The comment that was optionally added when this alert was closed */ resolution_comment?: string | null; /** @@ -11733,6 +12722,10 @@ export interface components { * @enum {string} */ validity?: "active" | "inactive" | "unknown"; + /** @description Whether the secret was publicly leaked. */ + publicly_leaked?: boolean | null; + /** @description Whether the detected secret was found in multiple repositories in the same organization or enterprise. */ + multi_repo?: boolean | null; }; /** * Actor @@ -11834,6 +12827,8 @@ export interface components { slug?: string; /** @example MDExOkludGVncmF0aW9uMQ== */ node_id: string; + /** @example "Iv1.25b5d1e65ffc4022" */ + client_id?: string; owner: components["schemas"]["nullable-simple-user"]; /** * @description The name of the GitHub app @@ -11890,8 +12885,6 @@ export interface components { * @example 5 */ installations_count?: number; - /** @example "Iv1.25b5d1e65ffc4022" */ - client_id?: string; /** @example "1d4b2097ac622ba702d19de498f005747a8b21d3" */ client_secret?: string; /** @example "6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b" */ @@ -11928,6 +12921,12 @@ export interface components { eyes: number; rocket: number; }; + /** Sub-issues Summary */ + "sub-issues-summary": { + total: number; + completed: number; + percent_completed: number; + }; /** * Issue * @description Issues are a great way to keep track of tasks, enhancements, and bugs for your projects. @@ -12035,6 +13034,7 @@ export interface components { performed_via_github_app?: components["schemas"]["nullable-integration"]; author_association: components["schemas"]["author-association"]; reactions?: components["schemas"]["reaction-rollup"]; + sub_issues_summary?: components["schemas"]["sub-issues-summary"]; }; /** * Issue Comment @@ -12194,6 +13194,11 @@ export interface components { language?: string; raw_url?: string; size?: number; + /** + * @description The encoding used for `content`. Currently, `"utf-8"` and `"base64"` are supported. + * @default utf-8 + */ + encoding?: string; }; }; public: boolean; @@ -12203,6 +13208,7 @@ export interface components { updated_at: string; description: string | null; comments: number; + comments_enabled?: boolean; user: components["schemas"]["nullable-simple-user"]; /** Format: uri */ comments_url: string; @@ -12217,7 +13223,9 @@ export interface components { */ "public-user": { login: string; + /** Format: int64 */ id: number; + user_view_type?: string; node_id: string; /** Format: uri */ avatar_url: string; @@ -12248,6 +13256,8 @@ export interface components { location: string | null; /** Format: email */ email: string | null; + /** Format: email */ + notification_email?: string | null; hireable: boolean | null; bio: string | null; twitter_username?: string | null; @@ -12265,8 +13275,6 @@ export interface components { space: number; private_repos: number; }; - /** Format: date-time */ - suspended_at?: string | null; /** @example 1 */ private_gists?: number; /** @example 2 */ @@ -12350,6 +13358,7 @@ export interface components { updated_at: string; description: string | null; comments: number; + comments_enabled?: boolean; user: components["schemas"]["nullable-simple-user"]; /** Format: uri */ comments_url: string; @@ -12375,6 +13384,11 @@ export interface components { size?: number; truncated?: boolean; content?: string; + /** + * @description The encoding used for `content`. Currently, `"utf-8"` and `"base64"` are supported. + * @default utf-8 + */ + encoding?: string; } | null; }; public?: boolean; @@ -12382,6 +13396,7 @@ export interface components { updated_at?: string; description?: string | null; comments?: number; + comments_enabled?: boolean; user?: string | null; comments_url?: string; owner?: components["schemas"]["simple-user"]; @@ -12717,18 +13732,49 @@ export interface components { * ] */ actions?: string[]; + /** + * @example [ + * "192.0.2.1" + * ] + */ + actions_macos?: string[]; + /** + * @example [ + * "192.0.2.1" + * ] + */ + codespaces?: string[]; /** * @example [ * "192.0.2.1" * ] */ dependabot?: string[]; + /** + * @example [ + * "192.0.2.1" + * ] + */ + copilot?: string[]; domains?: { website?: string[]; codespaces?: string[]; copilot?: string[]; packages?: string[]; actions?: string[]; + actions_inbound?: { + full_domains?: string[]; + wildcard_domains?: string[]; + }; + artifact_attestations?: { + /** + * @example [ + * "example" + * ] + */ + trust_domain?: string; + services?: string[]; + }; }; }; "security-and-analysis": { @@ -12752,13 +13798,24 @@ export interface components { /** @enum {string} */ status?: "enabled" | "disabled"; }; + secret_scanning_non_provider_patterns?: { + /** @enum {string} */ + status?: "enabled" | "disabled"; + }; + secret_scanning_ai_detection?: { + /** @enum {string} */ + status?: "enabled" | "disabled"; + }; } | null; /** * Minimal Repository * @description Minimal Repository */ "minimal-repository": { - /** @example 1296269 */ + /** + * Format: int64 + * @example 1296269 + */ id: number; /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */ node_id: string; @@ -13054,6 +14111,32 @@ export interface components { /** @example A great organization */ description: string | null; }; + "billing-usage-report": { + usageItems?: { + /** @description Date of the usage line item. */ + date: string; + /** @description Product name. */ + product: string; + /** @description SKU name. */ + sku: string; + /** @description Quantity of the usage line item. */ + quantity: number; + /** @description Unit type of the usage line item. */ + unitType: string; + /** @description Price per unit of the usage line item. */ + pricePerUnit: number; + /** @description Gross amount of the usage line item. */ + grossAmount: number; + /** @description Discount amount of the usage line item. */ + discountAmount: number; + /** @description Net amount of the usage line item. */ + netAmount: number; + /** @description Name of the organization. */ + organizationName: string; + /** @description Name of the repository. */ + repositoryName?: string; + }[]; + }; /** * Organization Full * @description Organization Full @@ -13139,7 +14222,12 @@ export interface components { private_gists?: number | null; /** @example 10000 */ disk_usage?: number | null; - /** @example 8 */ + /** + * @description The number of collaborators on private repositories. + * + * This field may be null if the number of private repositories is over 50,000. + * @example 8 + */ collaborators?: number | null; /** * Format: email @@ -13177,47 +14265,60 @@ export interface components { /** @example false */ web_commit_signoff_required?: boolean; /** - * @description Whether GitHub Advanced Security is enabled for new repositories and repositories transferred to this organization. + * @deprecated + * @description **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + * + * 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. * @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. + * @deprecated + * @description **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + * + * Whether Dependabot alerts are automatically 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. * @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. + * @deprecated + * @description **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + * + * Whether Dependabot security updates are automatically 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. * @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. + * @deprecated + * @description **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + * + * Whether dependency graph is automatically 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. * @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. + * @deprecated + * @description **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + * + * Whether secret scanning is automatically 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. * @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. + * @deprecated + * @description **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + * + * Whether secret scanning push protection is automatically 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. * @example false @@ -13242,6 +14343,11 @@ export interface components { updated_at: string; /** Format: date-time */ archived_at: string | null; + /** + * @description Controls whether or not deploy keys may be added and used for repositories in the organization. + * @example false + */ + deploy_keys_enabled_for_repositories?: boolean; }; "actions-cache-usage-org-enterprise": { /** @description The count of active caches across all repositories of an enterprise or an organization. */ @@ -13310,7 +14416,8 @@ export interface components { /** * @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[]; }; @@ -13329,6 +14436,31 @@ export interface components { default_workflow_permissions?: components["schemas"]["actions-default-workflow-permissions"]; can_approve_pull_request_reviews?: components["schemas"]["actions-can-approve-pull-request-reviews"]; }; + "runner-groups-org": { + id: number; + name: string; + visibility: string; + default: boolean; + /** @description Link to the selected repositories resource for this runner group. Not present unless visibility was set to `selected` */ + selected_repositories_url?: string; + runners_url: string; + hosted_runners_url?: string; + inherited: boolean; + inherited_allows_public_repositories?: boolean; + allows_public_repositories: boolean; + /** + * @description If `true`, the `restricted_to_workflows` and `selected_workflows` fields cannot be modified. + * @default false + */ + 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; + /** @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[]; + }; /** * Self hosted runner label * @description A label for a self hosted runner @@ -13542,18 +14674,18 @@ export interface components { readonly "alert-instances-url": string; /** * @description State of a code scanning alert. - * @enum {string} + * @enum {string|null} */ - "code-scanning-alert-state": "open" | "dismissed" | "fixed"; + "code-scanning-alert-state": "open" | "dismissed" | "fixed" | null; /** * @description **Required when the state is dismissed.** The reason for dismissing or closing the alert. * @enum {string|null} */ "code-scanning-alert-dismissed-reason": - | null | "false positive" | "won't fix" - | "used in tests"; + | "used in tests" + | null; /** @description The dismissal comment associated with the dismissal of the alert. */ "code-scanning-alert-dismissed-comment": string | null; "code-scanning-alert-rule-summary": { @@ -13561,8 +14693,6 @@ export interface components { id?: string | null; /** @description The name of the rule used to detect the alert. */ name?: string; - /** @description A set of tags applicable for the rule. */ - tags?: string[] | null; /** * @description The severity of the alert. * @enum {string|null} @@ -13575,6 +14705,14 @@ export interface components { security_severity_level?: "low" | "medium" | "high" | "critical" | null; /** @description A short description of the rule used to detect the alert. */ description?: string; + /** @description A description of the rule used to detect the alert. */ + full_description?: string; + /** @description A set of tags applicable for the rule. */ + tags?: string[] | null; + /** @description Detailed documentation for the rule as GitHub Flavored Markdown. */ + help?: string | null; + /** @description A link to the documentation for the rule used to detect the alert. */ + help_uri?: string | null; }; /** @description The version of the tool used to generate the code scanning analysis. */ "code-scanning-analysis-tool-version": string | null; @@ -13695,7 +14833,10 @@ export interface components { * @description A codespace. */ codespace: { - /** @example 1 */ + /** + * Format: int64 + * @example 1 + */ id: number; /** * @description Automatically generated name of this codespace. @@ -13936,8 +15077,8 @@ export interface components { inactive_this_cycle?: number; }; /** - * Copilot Business Organization Details - * @description Information about the seat breakdown and policies set for an organization with a Copilot Business subscription. + * Copilot Organization Details + * @description Information about the seat breakdown and policies set for an organization with a Copilot Business or Copilot Enterprise subscription. */ "copilot-organization-details": { seat_breakdown: components["schemas"]["copilot-seat-breakdown"]; @@ -13970,8 +15111,52 @@ export interface components { | "assign_selected" | "disabled" | "unconfigured"; + /** + * @description The Copilot plan of the organization, or the parent enterprise, when applicable. + * @enum {string} + */ + plan_type?: "business" | "enterprise" | "unknown"; [key: string]: unknown; }; + /** + * Organization Simple + * @description A GitHub organization. + */ + "nullable-organization-simple": { + /** @example github */ + login: string; + /** @example 1 */ + id: number; + /** @example MDEyOk9yZ2FuaXphdGlvbjE= */ + node_id: string; + /** + * Format: uri + * @example https://api.github.com/orgs/github + */ + url: string; + /** + * Format: uri + * @example https://api.github.com/orgs/github/repos + */ + repos_url: string; + /** + * Format: uri + * @example https://api.github.com/orgs/github/events + */ + events_url: string; + /** @example https://api.github.com/orgs/github/hooks */ + hooks_url: string; + /** @example https://api.github.com/orgs/github/issues */ + issues_url: string; + /** @example https://api.github.com/orgs/github/members{/member} */ + members_url: string; + /** @example https://api.github.com/orgs/github/public_members{/member} */ + public_members_url: string; + /** @example https://github.com/images/error/octocat_happy.gif */ + avatar_url: string; + /** @example A great organization */ + description: string | null; + } | null; /** * Team Simple * @description Groups of organization members that gives permissions on specified repositories. @@ -14068,99 +15253,43 @@ export interface components { parent: components["schemas"]["nullable-team-simple"]; }; /** - * Organization - * @description GitHub account for managing multiple users, teams, and repositories + * Enterprise Team + * @description Group of enterprise owners and/or members */ - organization: { - /** - * @description Unique login name of the organization - * @example new-org - */ - login: string; - /** - * Format: uri - * @description URL for the organization - * @example https://api.github.com/orgs/github - */ - url: string; + "enterprise-team": { + /** Format: int64 */ id: number; - node_id: string; - /** Format: uri */ - repos_url: string; + name: string; + slug: string; /** Format: uri */ - events_url: string; - hooks_url: string; - issues_url: string; - members_url: string; - public_members_url: string; - avatar_url: string; - description: string | null; + url: string; + /** @example disabled | all */ + sync_to_organizations: string; + /** @example 62ab9291-fae2-468e-974b-7e45096d5021 */ + group_id?: string | null; /** * Format: uri - * @description Display blog url for the organization - * @example blog.example-org.com + * @example https://github.com/enterprises/dc/teams/justice-league */ - blog?: string; - /** Format: uri */ html_url: string; - /** - * @description Display name for the organization - * @example New Org - */ - name?: string; - /** - * @description Display company name for the organization - * @example Acme corporation - */ - company?: string; - /** - * @description Display location for the organization - * @example Berlin, Germany - */ - location?: string; - /** - * Format: email - * @description Display email for the organization - * @example org@example.com - */ - email?: string; - /** @description Specifies if organization projects are enabled for this org */ - has_organization_projects: boolean; - /** @description Specifies if repository projects are enabled for repositories that belong to this org */ - has_repository_projects: boolean; - is_verified?: boolean; - public_repos: number; - public_gists: number; - followers: number; - following: number; - type: string; + members_url: string; /** Format: date-time */ created_at: string; /** Format: date-time */ updated_at: string; - plan?: { - name?: string; - space?: number; - private_repos?: number; - filled_seats?: number; - seats?: number; - }; }; /** * Copilot Business Seat Detail * @description Information about a Copilot Business seat assignment for a user, team, or organization. */ "copilot-seat-details": { - /** @description The assignee that has been granted access to GitHub Copilot. */ - assignee: { - [key: string]: unknown; - } & ( - | components["schemas"]["simple-user"] + assignee: components["schemas"]["simple-user"]; + organization?: components["schemas"]["nullable-organization-simple"]; + /** @description The team through which the assignee is granted access to GitHub Copilot, if applicable. */ + assigning_team?: | components["schemas"]["team"] - | components["schemas"]["organization"] - ); - /** @description The team that granted access to GitHub Copilot to the assignee. This will be null if the user was assigned a seat individually. */ - assigning_team?: components["schemas"]["team"] | null; + | components["schemas"]["enterprise-team"] + | null; /** * Format: date * @description The pending cancellation date for the seat, in `YYYY-MM-DD` format. This will be null unless the assignee's Copilot access has been canceled during the current billing cycle. If the seat has been cancelled, this corresponds to the start of the organization's next billing cycle. @@ -14180,9 +15309,202 @@ export interface components { created_at: string; /** * Format: date-time - * @description Timestamp of when the assignee's GitHub Copilot access was last updated, in ISO 8601 format. + * @deprecated + * @description **Closing down notice:** This field is no longer relevant and is closing down. Use the `created_at` field to determine when the assignee was last granted access to GitHub Copilot. Timestamp of when the assignee's GitHub Copilot access was last updated, in ISO 8601 format. */ updated_at?: string; + /** + * @description The Copilot plan of the organization, or the parent enterprise, when applicable. + * @enum {string} + */ + plan_type?: "business" | "enterprise" | "unknown"; + }; + /** @description Usage metrics for Copilot editor code completions in the IDE. */ + "copilot-ide-code-completions": { + /** @description Number of users who accepted at least one Copilot code suggestion, across all active editors. Includes both full and partial acceptances. */ + total_engaged_users?: number; + /** @description Code completion metrics for active languages. */ + languages?: { + /** @description Name of the language used for Copilot code completion suggestions. */ + name?: string; + /** @description Number of users who accepted at least one Copilot code completion suggestion for the given language. Includes both full and partial acceptances. */ + total_engaged_users?: number; + }[]; + editors?: { + /** @description Name of the given editor. */ + name?: string; + /** @description Number of users who accepted at least one Copilot code completion suggestion for the given editor. Includes both full and partial acceptances. */ + total_engaged_users?: number; + /** @description List of model metrics for custom models and the default model. */ + models?: { + /** @description Name of the model used for Copilot code completion suggestions. If the default model is used will appear as 'default'. */ + name?: string; + /** @description Indicates whether a model is custom or default. */ + is_custom_model?: boolean; + /** @description The training date for the custom model. */ + custom_model_training_date?: string | null; + /** @description Number of users who accepted at least one Copilot code completion suggestion for the given editor, for the given language and model. Includes both full and partial acceptances. */ + total_engaged_users?: number; + /** @description Code completion metrics for active languages, for the given editor. */ + languages?: { + /** @description Name of the language used for Copilot code completion suggestions, for the given editor. */ + name?: string; + /** @description Number of users who accepted at least one Copilot code completion suggestion for the given editor, for the given language. Includes both full and partial acceptances. */ + total_engaged_users?: number; + /** @description The number of Copilot code suggestions generated for the given editor, for the given language. */ + total_code_suggestions?: number; + /** @description The number of Copilot code suggestions accepted for the given editor, for the given language. Includes both full and partial acceptances. */ + total_code_acceptances?: number; + /** @description The number of lines of code suggested by Copilot code completions for the given editor, for the given language. */ + total_code_lines_suggested?: number; + /** @description The number of lines of code accepted from Copilot code suggestions for the given editor, for the given language. */ + total_code_lines_accepted?: number; + }[]; + }[]; + [key: string]: unknown; + }[]; + [key: string]: unknown; + } | null; + /** @description Usage metrics for Copilot Chat in the IDE. */ + "copilot-ide-chat": { + /** @description Total number of users who prompted Copilot Chat in the IDE. */ + total_engaged_users?: number; + editors?: { + /** @description Name of the given editor. */ + name?: string; + /** @description The number of users who prompted Copilot Chat in the specified editor. */ + total_engaged_users?: number; + /** @description List of model metrics for custom models and the default model. */ + models?: { + /** @description Name of the model used for Copilot code completion suggestions. If the default model is used will appear as 'default'. */ + name?: string; + /** @description Indicates whether a model is custom or default. */ + is_custom_model?: boolean; + /** @description The training date for the custom model. */ + custom_model_training_date?: string | null; + /** @description The number of users who prompted Copilot Chat in the given editor and model. */ + total_engaged_users?: number; + /** @description The total number of chats initiated by users in the given editor and model. */ + total_chats?: number; + /** @description The number of times users accepted a code suggestion from Copilot Chat using the 'Insert Code' UI element, for the given editor. */ + total_chat_insertion_events?: number; + /** @description The number of times users copied a code suggestion from Copilot Chat using the keyboard, or the 'Copy' UI element, for the given editor. */ + total_chat_copy_events?: number; + }[]; + }[]; + [key: string]: unknown; + } | null; + /** @description Usage metrics for Copilot Chat in github.com */ + "copilot-dotcom-chat": { + /** @description Total number of users who prompted Copilot Chat on github.com at least once. */ + total_engaged_users?: number; + /** @description List of model metrics for a custom models and the default model. */ + models?: { + /** @description Name of the model used for Copilot code completion suggestions. If the default model is used will appear as 'default'. */ + name?: string; + /** @description Indicates whether a model is custom or default. */ + is_custom_model?: boolean; + /** @description The training date for the custom model (if applicable). */ + custom_model_training_date?: string | null; + /** @description Total number of users who prompted Copilot Chat on github.com at least once for each model. */ + total_engaged_users?: number; + /** @description Total number of chats initiated by users on github.com. */ + total_chats?: number; + }[]; + [key: string]: unknown; + } | null; + /** @description Usage metrics for Copilot for pull requests. */ + "copilot-dotcom-pull-requests": { + /** @description The number of users who used Copilot for Pull Requests on github.com to generate a pull request summary at least once. */ + total_engaged_users?: number; + /** @description Repositories in which users used Copilot for Pull Requests to generate pull request summaries */ + repositories?: { + /** @description Repository name */ + name?: string; + /** @description The number of users who generated pull request summaries using Copilot for Pull Requests in the given repository. */ + total_engaged_users?: number; + /** @description List of model metrics for custom models and the default model. */ + models?: { + /** @description Name of the model used for Copilot code completion suggestions. If the default model is used will appear as 'default'. */ + name?: string; + /** @description Indicates whether a model is custom or default. */ + is_custom_model?: boolean; + /** @description The training date for the custom model. */ + custom_model_training_date?: string | null; + /** @description The number of pull request summaries generated using Copilot for Pull Requests in the given repository. */ + total_pr_summaries_created?: number; + /** @description The number of users who generated pull request summaries using Copilot for Pull Requests in the given repository and model. */ + total_engaged_users?: number; + }[]; + }[]; + [key: string]: unknown; + } | null; + /** + * Copilot Usage Metrics + * @description Copilot usage metrics for a given day. + */ + "copilot-usage-metrics-day": { + /** + * Format: date + * @description The date for which the usage metrics are aggregated, in `YYYY-MM-DD` format. + */ + date: string; + /** @description The total number of Copilot users with activity belonging to any Copilot feature, globally, for the given day. Includes passive activity such as receiving a code suggestion, as well as engagement activity such as accepting a code suggestion or prompting chat. Does not include authentication events. Is not limited to the individual features detailed on the endpoint. */ + total_active_users?: number; + /** @description The total number of Copilot users who engaged with any Copilot feature, for the given day. Examples include but are not limited to accepting a code suggestion, prompting Copilot chat, or triggering a PR Summary. Does not include authentication events. Is not limited to the individual features detailed on the endpoint. */ + total_engaged_users?: number; + copilot_ide_code_completions?: components["schemas"]["copilot-ide-code-completions"]; + copilot_ide_chat?: components["schemas"]["copilot-ide-chat"]; + copilot_dotcom_chat?: components["schemas"]["copilot-dotcom-chat"]; + copilot_dotcom_pull_requests?: components["schemas"]["copilot-dotcom-pull-requests"]; + [key: string]: unknown; + }; + /** + * Copilot Usage Metrics + * @description Summary of Copilot usage. + */ + "copilot-usage-metrics": { + /** + * Format: date + * @description The date for which the usage metrics are reported, in `YYYY-MM-DD` format. + */ + day: string; + /** @description The total number of Copilot code completion suggestions shown to users. */ + total_suggestions_count?: number; + /** @description The total number of Copilot code completion suggestions accepted by users. */ + total_acceptances_count?: number; + /** @description The total number of lines of code completions suggested by Copilot. */ + total_lines_suggested?: number; + /** @description The total number of lines of code completions accepted by users. */ + total_lines_accepted?: number; + /** @description The total number of users who were shown Copilot code completion suggestions during the day specified. */ + total_active_users?: number; + /** @description The total instances of users who accepted code suggested by Copilot Chat in the IDE (panel and inline). */ + total_chat_acceptances?: number; + /** @description The total number of chat turns (prompt and response pairs) sent between users and Copilot Chat in the IDE. */ + total_chat_turns?: number; + /** @description The total number of users who interacted with Copilot Chat in the IDE during the day specified. */ + total_active_chat_users?: number; + /** @description Breakdown of Copilot code completions usage by language and editor */ + breakdown: + | { + /** @description The language in which Copilot suggestions were shown to users in the specified editor. */ + language?: string; + /** @description The editor in which Copilot suggestions were shown to users for the specified language. */ + editor?: string; + /** @description The number of Copilot suggestions shown to users in the editor specified during the day specified. */ + suggestions_count?: number; + /** @description The number of Copilot suggestions accepted by users in the editor specified during the day specified. */ + acceptances_count?: number; + /** @description The number of lines of code suggested by Copilot in the editor specified during the day specified. */ + lines_suggested?: number; + /** @description The number of lines of code accepted by users in the editor specified during the day specified. */ + lines_accepted?: number; + /** @description The number of users who were shown Copilot completion suggestions in the editor specified during the day specified. */ + active_users?: number; + [key: string]: unknown; + }[] + | null; }; /** * Dependabot Secret for an Organization @@ -14230,7 +15552,10 @@ export interface components { * @description Minimal Repository */ "nullable-minimal-repository": { - /** @example 1296269 */ + /** + * Format: int64 + * @example 1296269 + */ id: number; /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */ node_id: string; @@ -14488,6 +15813,7 @@ export interface components { * @description Organization Invitation */ "organization-invitation": { + /** Format: int64 */ id: number; login: string | null; email: string | null; @@ -14559,6 +15885,87 @@ export interface components { created_at: string; type: string; }; + /** + * Route Stats + * @description API Insights usage route stats for an actor + */ + "api-insights-route-stats": { + /** @description The HTTP method */ + http_method?: string; + /** @description The API path's route template */ + api_route?: string; + /** + * Format: int64 + * @description The total number of requests within the queried time period + */ + total_request_count?: number; + /** + * Format: int64 + * @description The total number of requests that were rate limited within the queried time period + */ + rate_limited_request_count?: number; + last_rate_limited_timestamp?: string | null; + last_request_timestamp?: string; + }[]; + /** + * Subject Stats + * @description API Insights usage subject stats for an organization + */ + "api-insights-subject-stats": { + subject_type?: string; + subject_name?: string; + /** Format: int64 */ + subject_id?: number; + total_request_count?: number; + rate_limited_request_count?: number; + last_rate_limited_timestamp?: string | null; + last_request_timestamp?: string; + }[]; + /** + * Summary Stats + * @description API Insights usage summary stats for an organization + */ + "api-insights-summary-stats": { + /** + * Format: int64 + * @description The total number of requests within the queried time period + */ + total_request_count?: number; + /** + * Format: int64 + * @description The total number of requests that were rate limited within the queried time period + */ + rate_limited_request_count?: number; + }; + /** + * Time Stats + * @description API Insights usage time stats for an organization + */ + "api-insights-time-stats": { + timestamp?: string; + /** Format: int64 */ + total_request_count?: number; + /** Format: int64 */ + rate_limited_request_count?: number; + }[]; + /** + * User Stats + * @description API Insights usage stats for a user + */ + "api-insights-user-stats": { + actor_type?: string; + actor_name?: string; + /** Format: int64 */ + actor_id?: number; + /** Format: int64 */ + integration_id?: number | null; + /** Format: int64 */ + oauth_application_id?: number | null; + total_request_count?: number; + rate_limited_request_count?: number; + last_rate_limited_timestamp?: string | null; + last_request_timestamp?: string; + }[]; /** * @description The type of GitHub user that can comment, open issues, or create pull requests while the interaction limit is in effect. * @example collaborators_only @@ -14639,7 +16046,10 @@ export interface components { * @description A migration. */ migration: { - /** @example 79 */ + /** + * Format: int64 + * @example 79 + */ id: number; owner: components["schemas"]["nullable-simple-user"]; /** @example 0b989ba4-242f-11e5-81e1-c7b6966d2516 */ @@ -14677,25 +16087,30 @@ export interface components { /** @description Exclude related items from being returned in the response in order to improve performance of the request. The array can include any of: `"repositories"`. */ exclude?: string[]; }; - /** - * Organization Fine-Grained Permission - * @description A fine-grained permission that protects organization resources. - */ - "organization-fine-grained-permission": { - name: string; - description: string; - }; /** * Organization Role * @description Organization roles */ "organization-role": { - /** @description The unique identifier of the role. */ + /** + * Format: int64 + * @description The unique identifier of the role. + */ id: number; /** @description The name of the role. */ name: string; /** @description A short description about who this role is for or what permissions it grants. */ description?: string | null; + /** + * @description The system role from which this role inherits permissions. + * @enum {string|null} + */ + base_role?: "read" | "triage" | "write" | "maintain" | "admin" | null; + /** + * @description Source answers the question, "where did this role come from?" + * @enum {string|null} + */ + source?: "Organization" | "Enterprise" | "Predefined" | null; /** @description A list of permissions included in this role. */ permissions: string[]; organization: components["schemas"]["nullable-simple-user"]; @@ -14710,6 +16125,186 @@ export interface components { */ updated_at: string; }; + /** + * A Role Assignment for a Team + * @description The Relationship a Team has with a role. + */ + "team-role-assignment": { + /** + * @description Determines if the team has a direct, indirect, or mixed relationship to a role + * @example direct + * @enum {string} + */ + assignment?: "direct" | "indirect" | "mixed"; + id: number; + node_id: string; + name: string; + slug: string; + description: string | null; + privacy?: string; + notification_setting?: string; + permission: string; + permissions?: { + pull: boolean; + triage: boolean; + push: boolean; + maintain: boolean; + admin: boolean; + }; + /** Format: uri */ + url: string; + /** + * Format: uri + * @example https://github.com/orgs/rails/teams/core + */ + html_url: string; + members_url: string; + /** Format: uri */ + repositories_url: string; + parent: components["schemas"]["nullable-team-simple"]; + }; + /** + * Team Simple + * @description Groups of organization members that gives permissions on specified repositories. + */ + "team-simple": { + /** + * @description Unique identifier of the team + * @example 1 + */ + id: number; + /** @example MDQ6VGVhbTE= */ + node_id: string; + /** + * Format: uri + * @description URL for the team + * @example https://api.github.com/organizations/1/team/1 + */ + url: string; + /** @example https://api.github.com/organizations/1/team/1/members{/member} */ + members_url: string; + /** + * @description Name of the team + * @example Justice League + */ + name: string; + /** + * @description Description of the team + * @example A great team. + */ + description: string | null; + /** + * @description Permission that the team will have for its repositories + * @example admin + */ + permission: string; + /** + * @description The level of privacy this team should have + * @example closed + */ + privacy?: string; + /** + * @description The notification setting the team has set + * @example notifications_enabled + */ + notification_setting?: string; + /** + * Format: uri + * @example https://github.com/orgs/rails/teams/core + */ + html_url: string; + /** + * Format: uri + * @example https://api.github.com/organizations/1/team/1/repos + */ + repositories_url: string; + /** @example justice-league */ + slug: string; + /** + * @description Distinguished Name (DN) that team maps to within LDAP environment + * @example uid=example,ou=users,dc=github,dc=com + */ + ldap_dn?: string; + }; + /** + * A Role Assignment for a User + * @description The Relationship a User has with a role. + */ + "user-role-assignment": { + /** + * @description Determines if the user has a direct, indirect, or mixed relationship to a role + * @example direct + * @enum {string} + */ + assignment?: "direct" | "indirect" | "mixed"; + /** @description Team the user has gotten the role through */ + inherited_from?: components["schemas"]["team-simple"][]; + name?: string | null; + email?: string | null; + /** @example octocat */ + login: string; + /** @example 1 */ + id: number; + /** @example MDQ6VXNlcjE= */ + node_id: string; + /** + * Format: uri + * @example https://github.com/images/error/octocat_happy.gif + */ + avatar_url: string; + /** @example 41d064eb2195891e12d0413f63227ea7 */ + gravatar_id: string | null; + /** + * Format: uri + * @example https://api.github.com/users/octocat + */ + url: string; + /** + * Format: uri + * @example https://github.com/octocat + */ + html_url: string; + /** + * Format: uri + * @example https://api.github.com/users/octocat/followers + */ + followers_url: string; + /** @example https://api.github.com/users/octocat/following{/other_user} */ + following_url: string; + /** @example https://api.github.com/users/octocat/gists{/gist_id} */ + gists_url: string; + /** @example https://api.github.com/users/octocat/starred{/owner}{/repo} */ + starred_url: string; + /** + * Format: uri + * @example https://api.github.com/users/octocat/subscriptions + */ + subscriptions_url: string; + /** + * Format: uri + * @example https://api.github.com/users/octocat/orgs + */ + organizations_url: string; + /** + * Format: uri + * @example https://api.github.com/users/octocat/repos + */ + repos_url: string; + /** @example https://api.github.com/users/octocat/events{/privacy} */ + events_url: string; + /** + * Format: uri + * @example https://api.github.com/users/octocat/received_events + */ + received_events_url: string; + /** @example User */ + type: string; + site_admin: boolean; + /** @example "2020-07-09T00:17:55Z" */ + starred_at?: string; + /** @example public */ + user_view_type?: string; + }; /** * Package Version * @description A version of a software package @@ -14803,6 +16398,10 @@ export interface components { }; /** @description Date and time when the request for access was created. */ created_at: string; + /** @description Unique identifier of the user's token. This field can also be found in audit log events and the organization's settings for their PAT grants. */ + token_id: number; + /** @description The name given to the user's token. This field can also be found in an organization's settings page for Active Tokens. */ + token_name: string; /** @description Whether the associated fine-grained personal access token has expired. */ token_expired: boolean; /** @description Date and time when the associated fine-grained personal access token expires. */ @@ -14815,7 +16414,7 @@ export interface components { * @description Minimal representation of an organization programmatic access grant for enumerations */ "organization-programmatic-access-grant": { - /** @description Unique identifier of the fine-grained personal access token. The `pat_id` used to get details about an approved fine-grained personal access token. */ + /** @description Unique identifier of the fine-grained personal access token grant. The `pat_id` used to get details about an approved fine-grained personal access token. */ id: number; owner: components["schemas"]["simple-user"]; /** @@ -14839,6 +16438,10 @@ export interface components { }; /** @description Date and time when the fine-grained personal access token was approved to access the organization. */ access_granted_at: string; + /** @description Unique identifier of the user's token. This field can also be found in audit log events and the organization's settings for their PAT grants. */ + token_id: number; + /** @description The name given to the user's token. This field can also be found in an organization's settings page for Active Tokens. */ + token_name: string; /** @description Whether the associated fine-grained personal access token has expired. */ token_expired: boolean; /** @description Date and time when the associated fine-grained personal access token expires. */ @@ -14846,6 +16449,68 @@ export interface components { /** @description Date and time when the associated fine-grained personal access token was last used for authentication. */ token_last_used_at: string | null; }; + /** + * Organization private registry + * @description Private registry configuration for an organization + */ + "org-private-registry-configuration": { + /** + * @description The name of the private registry configuration. + * @example MAVEN_REPOSITORY_SECRET + */ + name: string; + /** + * @description The registry type. + * @enum {string} + */ + registry_type: "maven_repository"; + /** + * @description The username to use when authenticating with the private registry. + * @example monalisa + */ + username?: string | null; + /** + * @description Which type of organization repositories have access to the private registry. + * @enum {string} + */ + visibility: "all" | "private" | "selected"; + /** Format: date-time */ + created_at: string; + /** Format: date-time */ + updated_at: string; + }; + /** + * Organization private registry + * @description Private registry configuration for an organization + */ + "org-private-registry-configuration-with-selected-repositories": { + /** + * @description The name of the private registry configuration. + * @example MAVEN_REPOSITORY_SECRET + */ + name: string; + /** + * @description The registry type. + * @enum {string} + */ + registry_type: "maven_repository"; + /** + * @description The username to use when authenticating with the private registry. + * @example monalisa + */ + username?: string; + /** + * @description Which type of organization repositories have access to the private registry. `selected` means only the repositories specified by `selected_repository_ids` can access the private registry. + * @enum {string} + */ + visibility: "all" | "private" | "selected"; + /** @description An array of repository IDs that can access the organization private registry when `visibility` is set to `selected`. */ + selected_repository_ids?: number[]; + /** Format: date-time */ + created_at: string; + /** Format: date-time */ + updated_at: string; + }; /** * Project * @description Projects are a way to organize columns and cards of work. @@ -14915,15 +16580,26 @@ export interface components { * Organization Custom Property * @description Custom property defined on an organization */ - "org-custom-property": { + "custom-property": { /** @description The name of the property */ property_name: string; + /** + * Format: uri + * @description The URL that can be used to fetch, update, or delete info about this property via the API. + */ + url?: string; + /** + * @description The source type of the property + * @example organization + * @enum {string} + */ + source_type?: "organization" | "enterprise"; /** * @description The type of the value for the property * @example single_select * @enum {string} */ - value_type: "string" | "single_select"; + value_type: "string" | "single_select" | "multi_select" | "true_false"; /** @description Whether the property is required. */ required?: boolean; /** @description Default value of the property */ @@ -14942,6 +16618,29 @@ export interface components { */ values_editable_by?: "org_actors" | "org_and_repo_actors" | null; }; + /** + * Custom Property Set Payload + * @description Custom property set payload + */ + "custom-property-set-payload": { + /** + * @description The type of the value for the property + * @example single_select + * @enum {string} + */ + value_type: "string" | "single_select" | "multi_select" | "true_false"; + /** @description Whether the property is required. */ + required?: boolean; + /** @description Default value of the property */ + 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. + */ + allowed_values?: string[] | null; + }; /** * Custom Property Value * @description Custom property name and associated value @@ -14972,6 +16671,7 @@ export interface components { */ "nullable-repository": { /** + * Format: int64 * @description Unique identifier of the repository * @example 42 */ @@ -15263,7 +16963,7 @@ export interface components { 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. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -15347,7 +17047,10 @@ export interface components { * @description Full Repository */ "full-repository": { - /** @example 1296269 */ + /** + * Format: int64 + * @example 1296269 + */ id: number; /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */ node_id: string; @@ -15666,7 +17369,6 @@ export interface components { actor_id?: number | null; /** * @description The type of actor that can bypass a ruleset. - * * @enum {string} */ actor_type: @@ -15676,11 +17378,11 @@ export interface components { | "Team" | "DeployKey"; /** - * @description When the specified actor can bypass the ruleset. `pull_request` means that an actor can only bypass rules on pull requests. `pull_request` is not applicable for the `DeployKey` actor type. - * + * @description When the specified actor can bypass the ruleset. `pull_request` means that an actor can only bypass rules on pull requests. `pull_request` is not applicable for the `DeployKey` actor type. Also, `pull_request` is only applicable to branch rulesets. + * @default always * @enum {string} */ - bypass_mode: "always" | "pull_request"; + bypass_mode?: "always" | "pull_request"; }; /** * Repository ruleset conditions for ref names @@ -15727,6 +17429,11 @@ export interface components { name: string; /** @description The values to match for the repository property */ property_values: string[]; + /** + * @description The source of the repository property. Defaults to 'custom' if not specified. + * @enum {string} + */ + source?: "custom" | "system"; }; /** * Repository ruleset conditions for repository properties @@ -15742,7 +17449,10 @@ 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. + * @description Conditions for an organization ruleset. + * The branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties. + * The push rulesets conditions object does not require the `ref_name` property. + * For repository policy rulesets, the conditions object should only contain the `repository_name`, the `repository_id`, or the `repository_property`. */ "org-ruleset-conditions": | (components["schemas"]["repository-ruleset-conditions"] & @@ -15787,6 +17497,36 @@ export interface components { /** @enum {string} */ type: "required_linear_history"; }; + /** + * merge_queue + * @description Merges must be performed via a merge queue. + */ + "repository-rule-merge-queue": { + /** @enum {string} */ + type: "merge_queue"; + parameters?: { + /** @description Maximum time for a required status check to report a conclusion. After this much time has elapsed, checks that have not reported a conclusion will be assumed to have failed */ + check_response_timeout_minutes: number; + /** + * @description When set to ALLGREEN, the merge commit created by merge queue for each PR in the group must pass all required checks to merge. When set to HEADGREEN, only the commit at the head of the merge group, i.e. the commit containing changes from all of the PRs in the group, must pass its required checks to merge. + * @enum {string} + */ + grouping_strategy: "ALLGREEN" | "HEADGREEN"; + /** @description Limit the number of queued pull requests requesting checks and workflow runs at the same time. */ + max_entries_to_build: number; + /** @description The maximum number of PRs that will be merged together in a group. */ + max_entries_to_merge: number; + /** + * @description Method to use when merging changes from queued pull requests. + * @enum {string} + */ + merge_method: "MERGE" | "SQUASH" | "REBASE"; + /** @description The minimum number of PRs that will be merged together in a group. */ + min_entries_to_merge: number; + /** @description The time merge queue should wait after the first PR is added to the queue for the minimum group size to be met. After this time has elapsed, the minimum group size will be ignored and a smaller group will be merged. */ + min_entries_to_merge_wait_minutes: number; + }; + }; /** * required_deployments * @description Choose which environments must be successfully deployed to before refs can be pushed into a ref that matches this rule. @@ -15807,6 +17547,18 @@ export interface components { /** @enum {string} */ type: "required_signatures"; }; + /** + * RequiredReviewerConfiguration + * @description A reviewing team, and file patterns describing which files they must approve changes to. + */ + "repository-rule-params-required-reviewer-configuration": { + /** @description Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use the same syntax as `.gitignore` files. */ + file_patterns: string[]; + /** @description Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional. */ + minimum_approvals: number; + /** @description Node ID of the team which must review changes to matching files. */ + reviewer_id: string; + }; /** * pull_request * @description Require all commits be made to a non-target branch and submitted via a pull request before they can be merged. @@ -15815,6 +17567,8 @@ export interface components { /** @enum {string} */ type: "pull_request"; parameters?: { + /** @description When merging pull requests, you can allow any combination of merge commits, squashing, or rebasing. At least one option must be enabled. */ + allowed_merge_methods?: string[]; /** @description New, reviewable commits pushed will dismiss previous pull request review approvals. */ dismiss_stale_reviews_on_push: boolean; /** @description Require an approving review in pull requests that modify files that have a designated code owner. */ @@ -15845,6 +17599,8 @@ export interface components { /** @enum {string} */ type: "required_status_checks"; parameters?: { + /** @description Allow repositories and branches to be created if a check would otherwise prohibit it. */ + do_not_enforce_on_create?: boolean; /** @description Status checks that are required. */ required_status_checks: components["schemas"]["repository-rule-params-status-check-configuration"][]; /** @description Whether pull requests targeting a matching branch must be tested with the latest code. This setting will not take effect unless at least one status check is enabled. */ @@ -15996,6 +17752,8 @@ export interface components { /** @enum {string} */ type: "workflows"; parameters?: { + /** @description Allow repositories and branches to be created if a check would otherwise prohibit it. */ + do_not_enforce_on_create?: boolean; /** @description Workflows that must pass for this rule to pass. */ workflows: components["schemas"]["repository-rule-params-workflow-file-reference"][]; }; @@ -16023,6 +17781,18 @@ export interface components { /** @description The name of a code scanning tool */ tool: string; }; + /** + * code_scanning + * @description Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated. + */ + "repository-rule-code-scanning": { + /** @enum {string} */ + type: "code_scanning"; + parameters?: { + /** @description Tools that must provide code scanning results for this rule to pass. */ + code_scanning_tools: components["schemas"]["repository-rule-params-code-scanning-tool"][]; + }; + }; /** * Repository Rule * @description A repository rule. @@ -16032,6 +17802,7 @@ export interface components { | components["schemas"]["repository-rule-update"] | components["schemas"]["repository-rule-deletion"] | components["schemas"]["repository-rule-required-linear-history"] + | components["schemas"]["repository-rule-merge-queue"] | components["schemas"]["repository-rule-required-deployments"] | components["schemas"]["repository-rule-required-signatures"] | components["schemas"]["repository-rule-pull-request"] @@ -16074,7 +17845,8 @@ export interface components { max_file_size: number; }; } - | components["schemas"]["repository-rule-workflows"]; + | components["schemas"]["repository-rule-workflows"] + | components["schemas"]["repository-rule-code-scanning"]; /** * Repository ruleset * @description A set of rules to apply when specified conditions are met. @@ -16086,16 +17858,14 @@ export interface components { name: string; /** * @description The target of the ruleset - * - * **Note**: The `push` target is in beta and is subject to change. * @enum {string} */ - target?: "branch" | "tag" | "push"; + target?: "branch" | "tag" | "push" | "repository"; /** * @description The type of the source of the ruleset * @enum {string} */ - source_type?: "Repository" | "Organization"; + source_type?: "Repository" | "Organization" | "Enterprise"; /** @description The name of the source */ source: string; enforcement: components["schemas"]["repository-rule-enforcement"]; @@ -16116,7 +17886,7 @@ export interface components { html?: { /** @description The html URL of the ruleset */ href?: string; - }; + } | null; }; conditions?: | ( @@ -16165,7 +17935,7 @@ export interface components { * @description The result of the rule evaluations for rules with the `active` and `evaluate` enforcement statuses, demonstrating whether rules would pass or fail if all rules in the rule suite were `active`. * @enum {string} */ - evaluation_result?: "pass" | "fail"; + evaluation_result?: "pass" | "fail" | "bypass"; }[]; /** * Rule Suite @@ -16199,10 +17969,10 @@ export interface components { */ result?: "pass" | "fail" | "bypass"; /** - * @description The result of the rule evaluations for rules with the `active` and `evaluate` enforcement statuses, demonstrating whether rules would pass or fail if all rules in the rule suite were `active`. - * @enum {string} + * @description The result of the rule evaluations for rules with the `active` and `evaluate` enforcement statuses, demonstrating whether rules would pass or fail if all rules in the rule suite were `active`. Null if no rules with `evaluate` enforcement status were run. + * @enum {string|null} */ - evaluation_result?: "pass" | "fail"; + evaluation_result?: "pass" | "fail" | "bypass" | null; /** @description Details on the evaluated rules. */ rule_evaluations?: { rule_source?: { @@ -16225,8 +17995,8 @@ export interface components { result?: "pass" | "fail"; /** @description The type of rule. */ rule_type?: string; - /** @description Any associated details with the rule evaluation. */ - details?: string; + /** @description The detailed failure message for the rule. Null if the rule passed. */ + details?: string | null; }[]; }; /** @description A product affected by the vulnerability detailed in a repository security advisory. */ @@ -16335,6 +18105,7 @@ export interface components { /** @description The CVSS score. */ score: number | null; } | null; + cvss_severities?: components["schemas"]["cvss-severities"]; cwes: | readonly { /** @description The Common Weakness Enumeration (CWE) identifier. */ @@ -16362,69 +18133,6 @@ export interface components { /** @description A temporary private fork of the advisory's repository for collaborating on a fix. */ private_fork: components["schemas"]["simple-repository"] | null; }; - /** - * Team Simple - * @description Groups of organization members that gives permissions on specified repositories. - */ - "team-simple": { - /** - * @description Unique identifier of the team - * @example 1 - */ - id: number; - /** @example MDQ6VGVhbTE= */ - node_id: string; - /** - * Format: uri - * @description URL for the team - * @example https://api.github.com/organizations/1/team/1 - */ - url: string; - /** @example https://api.github.com/organizations/1/team/1/members{/member} */ - members_url: string; - /** - * @description Name of the team - * @example Justice League - */ - name: string; - /** - * @description Description of the team - * @example A great team. - */ - description: string | null; - /** - * @description Permission that the team will have for its repositories - * @example admin - */ - permission: string; - /** - * @description The level of privacy this team should have - * @example closed - */ - privacy?: string; - /** - * @description The notification setting the team has set - * @example notifications_enabled - */ - notification_setting?: string; - /** - * Format: uri - * @example https://github.com/orgs/rails/teams/core - */ - html_url: string; - /** - * Format: uri - * @example https://api.github.com/organizations/1/team/1/repos - */ - repositories_url: string; - /** @example justice-league */ - slug: string; - /** - * @description Distinguished Name (DN) that team maps to within LDAP environment - * @example uid=example,ou=users,dc=github,dc=com - */ - ldap_dn?: string; - }; "actions-billing-usage": { /** @description The sum of the free and paid GitHub Actions minutes used. */ total_minutes_used: number; @@ -17215,6 +18923,7 @@ export interface components { */ url: string; /** + * Format: int64 * @description The project card's ID * @example 42 */ @@ -17331,6 +19040,7 @@ export interface components { actions_runner_registration?: components["schemas"]["rate-limit"]; scim?: components["schemas"]["rate-limit"]; dependency_snapshots?: components["schemas"]["rate-limit"]; + code_scanning_autofix?: components["schemas"]["rate-limit"]; }; rate: components["schemas"]["rate-limit"]; }; @@ -17647,6 +19357,7 @@ export interface components { }; /** Pull Request Minimal */ "pull-request-minimal": { + /** Format: int64 */ id: number; number: number; url: string; @@ -17654,6 +19365,7 @@ export interface components { ref: string; sha: string; repo: { + /** Format: int64 */ id: number; url: string; name: string; @@ -17663,6 +19375,7 @@ export interface components { ref: string; sha: string; repo: { + /** Format: int64 */ id: number; url: string; name: string; @@ -17934,6 +19647,7 @@ export interface components { "pending-deployment": { environment: { /** + * Format: int64 * @description The id of the environment. * @example 56780428 */ @@ -17985,6 +19699,7 @@ export interface components { */ url: string; /** + * Format: int64 * @description Unique identifier of the deployment * @example 42 */ @@ -18320,6 +20035,7 @@ export interface components { apps_url: string; users: { login?: string; + /** Format: int64 */ id?: number; node_id?: string; avatar_url?: string; @@ -18337,6 +20053,7 @@ export interface components { received_events_url?: string; type?: string; site_admin?: boolean; + user_view_type?: string; }[]; teams: { id?: number; @@ -18392,8 +20109,11 @@ export interface components { type?: string; /** @example false */ site_admin?: boolean; + /** @example public */ + user_view_type?: string; }; name?: string; + client_id?: string; description?: string; external_url?: string; html_url?: string; @@ -18492,6 +20212,7 @@ export interface components { reason: string; payload: string | null; signature: string | null; + verified_at?: string | null; }; /** * Diff Entry @@ -18587,8 +20308,14 @@ export interface components { }; verification?: components["schemas"]["verification"]; }; - author: components["schemas"]["nullable-simple-user"]; - committer: components["schemas"]["nullable-simple-user"]; + author: + | components["schemas"]["simple-user"] + | components["schemas"]["empty-object"] + | null; + committer: + | components["schemas"]["simple-user"] + | components["schemas"]["empty-object"] + | null; parents: { /** @example 7638417db6d59f3c431d3e1f261cc637155684cd */ sha: string; @@ -18806,6 +20533,7 @@ export interface components { */ "check-run": { /** + * Format: int64 * @description The id of the check. * @example 21 */ @@ -18963,7 +20691,10 @@ export interface components { * @description A suite of checks performed on the code of a given code change */ "check-suite": { - /** @example 5 */ + /** + * Format: int64 + * @example 5 + */ id: number; /** @example MDEwOkNoZWNrU3VpdGU1 */ node_id: string; @@ -19068,7 +20799,7 @@ export interface components { security_severity_level?: "low" | "medium" | "high" | "critical" | null; /** @description A short description of the rule used to detect the alert. */ description?: string; - /** @description description of the rule used to detect the alert. */ + /** @description A description of the rule used to detect the alert. */ full_description?: string; /** @description A set of tags applicable for the rule. */ tags?: string[] | null; @@ -19099,6 +20830,40 @@ export interface components { * @enum {string} */ "code-scanning-alert-set-state": "open" | "dismissed"; + /** + * @description The status of an autofix. + * @enum {string} + */ + "code-scanning-autofix-status": + | "pending" + | "error" + | "success" + | "outdated"; + /** @description The description of an autofix. */ + "code-scanning-autofix-description": string | null; + /** + * Format: date-time + * @description The start time of an autofix in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + readonly "code-scanning-autofix-started-at": string; + "code-scanning-autofix": { + status: components["schemas"]["code-scanning-autofix-status"]; + description: components["schemas"]["code-scanning-autofix-description"]; + started_at: components["schemas"]["code-scanning-autofix-started-at"]; + }; + /** @description Commit an autofix for a code scanning alert */ + "code-scanning-autofix-commits": { + /** @description The Git reference of target branch for the commit. Branch needs to already exist. For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. */ + target_ref?: string; + /** @description Commit message to be used. */ + message?: string; + } | null; + "code-scanning-autofix-commits-response": { + /** @description The Git reference of target branch for the commit. For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. */ + target_ref?: string; + /** @description SHA of commit with autofix. */ + sha?: string; + }; /** * @description An identifier for the upload. * @example 6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53 @@ -19193,6 +20958,150 @@ export interface components { /** @description The commit SHA of the repository at the time the CodeQL database was created. */ commit_oid?: string | null; }; + /** + * @description The language targeted by the CodeQL query + * @enum {string} + */ + "code-scanning-variant-analysis-language": + | "cpp" + | "csharp" + | "go" + | "java" + | "javascript" + | "python" + | "ruby" + | "swift"; + /** + * Repository Identifier + * @description Repository Identifier + */ + "code-scanning-variant-analysis-repository": { + /** + * @description A unique identifier of the repository. + * @example 1296269 + */ + id: number; + /** + * @description The name of the repository. + * @example Hello-World + */ + name: string; + /** + * @description The full, globally unique, name of the repository. + * @example octocat/Hello-World + */ + full_name: string; + /** @description Whether the repository is private. */ + private: boolean; + /** @example 80 */ + stargazers_count: number; + /** + * Format: date-time + * @example 2011-01-26T19:14:43Z + */ + updated_at: string | null; + }; + /** + * @description The new status of the CodeQL variant analysis repository task. + * @enum {string} + */ + "code-scanning-variant-analysis-status": + | "pending" + | "in_progress" + | "succeeded" + | "failed" + | "canceled" + | "timed_out"; + "code-scanning-variant-analysis-skipped-repo-group": { + /** + * @description The total number of repositories that were skipped for this reason. + * @example 2 + */ + repository_count: number; + /** @description A list of repositories that were skipped. This list may not include all repositories that were skipped. This is only available when the repository was found and the user has access to it. */ + repositories: components["schemas"]["code-scanning-variant-analysis-repository"][]; + }; + /** + * Variant Analysis + * @description A run of a CodeQL query against one or more repositories. + */ + "code-scanning-variant-analysis": { + /** @description The ID of the variant analysis. */ + id: number; + controller_repo: components["schemas"]["simple-repository"]; + actor: components["schemas"]["simple-user"]; + query_language: components["schemas"]["code-scanning-variant-analysis-language"]; + /** @description The download url for the query pack. */ + query_pack_url: string; + /** + * Format: date-time + * @description The date and time at which the variant analysis was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. + */ + created_at?: string; + /** + * Format: date-time + * @description The date and time at which the variant analysis was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. + */ + updated_at?: string; + /** + * Format: date-time + * @description The date and time at which the variant analysis was completed, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. Will be null if the variant analysis has not yet completed or this information is not available. + */ + completed_at?: string | null; + /** @enum {string} */ + status: "in_progress" | "succeeded" | "failed" | "cancelled"; + /** @description The GitHub Actions workflow run used to execute this variant analysis. This is only available if the workflow run has started. */ + actions_workflow_run_id?: number; + /** + * @description The reason for a failure of the variant analysis. This is only available if the variant analysis has failed. + * @enum {string} + */ + failure_reason?: + | "no_repos_queried" + | "actions_workflow_run_failed" + | "internal_error"; + scanned_repositories?: { + repository: components["schemas"]["code-scanning-variant-analysis-repository"]; + analysis_status: components["schemas"]["code-scanning-variant-analysis-status"]; + /** @description The number of results in the case of a successful analysis. This is only available for successful analyses. */ + result_count?: number; + /** @description The size of the artifact. This is only available for successful analyses. */ + artifact_size_in_bytes?: number; + /** @description The reason of the failure of this repo task. This is only available if the repository task has failed. */ + failure_message?: string; + }[]; + /** @description Information about repositories that were skipped from processing. This information is only available to the user that initiated the variant analysis. */ + skipped_repositories?: { + access_mismatch_repos: components["schemas"]["code-scanning-variant-analysis-skipped-repo-group"]; + not_found_repos: { + /** + * @description The total number of repositories that were skipped for this reason. + * @example 2 + */ + repository_count: number; + /** @description A list of full repository names that were skipped. This list may not include all repositories that were skipped. */ + repository_full_names: string[]; + }; + no_codeql_db_repos: components["schemas"]["code-scanning-variant-analysis-skipped-repo-group"]; + over_limit_repos: components["schemas"]["code-scanning-variant-analysis-skipped-repo-group"]; + }; + }; + "code-scanning-variant-analysis-repo-task": { + repository: components["schemas"]["simple-repository"]; + analysis_status: components["schemas"]["code-scanning-variant-analysis-status"]; + /** @description The size of the artifact. This is only available for successful analyses. */ + artifact_size_in_bytes?: number; + /** @description The number of results in the case of a successful analysis. This is only available for successful analyses. */ + result_count?: number; + /** @description The reason of the failure of this repo task. This is only available if the repository task has failed. */ + failure_message?: string; + /** @description The SHA of the commit the CodeQL database was built against. This is only available for successful analyses. */ + database_commit_sha?: string; + /** @description The source location prefix to use. This is only available for successful analyses. */ + source_location_prefix?: string; + /** @description The URL of the artifact. This is only available for successful analyses. */ + artifact_url?: string; + }; /** @description Configuration for code scanning default setup. */ "code-scanning-default-setup": { /** @@ -19202,6 +21111,7 @@ export interface components { state?: "configured" | "not-configured"; /** @description Languages to be analyzed. */ languages?: ( + | "actions" | "c-cpp" | "csharp" | "go" @@ -19213,6 +21123,16 @@ export interface components { | "typescript" | "swift" )[]; + /** + * @description Runner type to be used. + * @enum {string|null} + */ + runner_type?: "standard" | "labeled" | null; + /** + * @description Runner label to be used if the runner type is labeled. + * @example code-scanning + */ + runner_label?: string | null; /** * @description CodeQL query suite to be used. * @enum {string} @@ -19237,6 +21157,16 @@ export interface components { * @enum {string} */ state?: "configured" | "not-configured"; + /** + * @description Runner type to be used. + * @enum {string} + */ + runner_type?: "standard" | "labeled"; + /** + * @description Runner label to be used if the runner type is labeled. + * @example code-scanning + */ + runner_label?: string | null; /** * @description CodeQL query suite to be used. * @enum {string} @@ -19244,6 +21174,7 @@ export interface components { query_suite?: "default" | "extended"; /** @description CodeQL languages to be analyzed. */ languages?: ( + | "actions" | "c-cpp" | "csharp" | "go" @@ -19294,6 +21225,23 @@ export interface components { /** @description Any errors that ocurred during processing of the delivery. */ errors?: readonly string[] | null; }; + /** @description Code security configuration associated with a repository and attachment status */ + "code-security-configuration-for-repository": { + /** + * @description The attachment status of the code security configuration on the repository. + * @enum {string} + */ + status?: + | "attached" + | "attaching" + | "detached" + | "removed" + | "enforced" + | "failed" + | "updating" + | "removed_by_enterprise"; + configuration?: components["schemas"]["code-security-configuration"]; + }; /** * CODEOWNERS errors * @description A list of errors found in a repo's CODEOWNERS file @@ -19415,7 +21363,10 @@ export interface components { collaborator: { /** @example octocat */ login: string; - /** @example 1 */ + /** + * Format: int64 + * @example 1 + */ id: number; email?: string | null; name?: string | null; @@ -19483,6 +21434,8 @@ export interface components { }; /** @example admin */ role_name: string; + /** @example public */ + user_view_type?: string; }; /** * Repository Invitation @@ -19490,6 +21443,7 @@ export interface components { */ "repository-invitation": { /** + * Format: int64 * @description Unique identifier of the repository invitation. * @example 42 */ @@ -19526,7 +21480,10 @@ export interface components { "nullable-collaborator": { /** @example octocat */ login: string; - /** @example 1 */ + /** + * Format: int64 + * @example 1 + */ id: number; email?: string | null; name?: string | null; @@ -19594,6 +21551,8 @@ export interface components { }; /** @example admin */ role_name: string; + /** @example public */ + user_view_type?: string; } | null; /** * Repository Collaborator Permission @@ -19674,7 +21633,10 @@ export interface components { * @example https://api.github.com/repos/octocat/Hello-World/pulls/1347 */ url: string; - /** @example 1 */ + /** + * Format: int64 + * @example 1 + */ id: number; /** @example MDExOlB1bGxSZXF1ZXN0MQ== */ node_id: string; @@ -19964,6 +21926,7 @@ export interface components { name: string; path: string; sha: string; + content?: string; /** Format: uri */ url: string; /** Format: uri */ @@ -19977,7 +21940,6 @@ export interface components { size: number; name: string; path: string; - content?: string; sha: string; /** Format: uri */ url: string; @@ -20178,6 +22140,23 @@ export interface components { reason?: string; signature?: string | null; payload?: string | null; + verified_at?: string | null; + }; + }; + }; + /** @description The ID of the push protection bypass placeholder. This value is returned on any push protected routes. */ + "secret-scanning-push-protection-bypass-placeholder-id": string; + /** @description Repository rule violation was detected */ + "repository-rule-violation-error": { + message?: string; + documentation_url?: string; + status?: string; + metadata?: { + secret_scanning?: { + bypass_placeholders?: { + placeholder_id?: components["schemas"]["secret-scanning-push-protection-bypass-placeholder-id"]; + token_type?: string; + }[]; }; }; }; @@ -20215,6 +22194,7 @@ export interface components { contributions: number; email?: string; name?: string; + user_view_type?: string; }; /** @description A Dependabot alert. */ "dependabot-alert": { @@ -20327,6 +22307,11 @@ export interface components { * @example SPDX-2.3 */ spdxVersion: string; + /** + * @description An optional comment about the SPDX document. + * @example Exact versions could not be resolved for some packages. For more information: https://docs.github.com/en/code-security/supply-chain-security/understanding-your-software-supply-chain/ + */ + comment?: string; creationInfo: { /** * @description The date and time the SPDX document was created. @@ -20346,11 +22331,9 @@ export interface components { * @example CC0-1.0 */ dataLicense: string; - /** @description The name of the repository that the SPDX document describes. */ - documentDescribes: string[]; /** * @description The namespace for the SPDX document. - * @example https://github.com/example/dependency_graph/sbom-123 + * @example https://spdx.org/spdxdocs/protobom/15e41dd2-f961-4f4d-b8dc-f8f57ad70d57 */ documentNamespace: string; packages: { @@ -20361,7 +22344,7 @@ export interface components { SPDXID?: string; /** * @description The name of the package. - * @example rubygems:github/github + * @example github/github */ name?: string; /** @@ -20398,6 +22381,11 @@ export interface components { * @example NOASSERTION */ supplier?: string; + /** + * @description The copyright holders of the package, and any dates present with those notices, if available. + * @example Copyright (c) 1985 GitHub.com + */ + copyrightText?: string; externalRefs?: { /** * @description The category of reference to an external resource this reference refers to. @@ -20416,6 +22404,17 @@ export interface components { referenceType: string; }[]; }[]; + relationships?: { + /** + * @description The type of relationship between the two SPDX elements. + * @example DEPENDS_ON + */ + relationshipType?: string; + /** @description The SPDX identifier of the package that is the source of the relationship. */ + spdxElementId?: string; + /** @description The SPDX identifier of the package that is the target of the relationship. */ + relatedSpdxElement?: string; + }[]; }; }; /** @@ -20543,7 +22542,10 @@ export interface components { * @example https://api.github.com/repos/octocat/example/deployments/42/statuses/1 */ url: string; - /** @example 1 */ + /** + * Format: int64 + * @example 1 + */ id: number; /** @example MDE2OkRlcGxveW1lbnRTdGF0dXMx */ node_id: string; @@ -20575,7 +22577,7 @@ export interface components { environment?: string; /** * Format: uri - * @description Deprecated: the URL to associate with this status. + * @description Closing down notice: the URL to associate with this status. * @default * @example https://example.com/deployment/42/output */ @@ -20634,6 +22636,7 @@ export interface components { */ environment: { /** + * Format: int64 * @description The id of the environment. * @example 56780428 */ @@ -20911,6 +22914,7 @@ export interface components { reason: string; signature: string | null; payload: string | null; + verified_at?: string | null; }; /** Format: uri */ html_url: string; @@ -21293,6 +23297,7 @@ export interface components { performed_via_github_app?: components["schemas"]["nullable-integration"]; author_association: components["schemas"]["author-association"]; reactions?: components["schemas"]["reaction-rollup"]; + sub_issues_summary?: components["schemas"]["sub-issues-summary"]; } | null; /** * Issue Event Label @@ -21710,6 +23715,7 @@ export interface components { label: { /** * Format: int64 + * @description Unique identifier for the label. * @example 208045946 */ id: number; @@ -21726,14 +23732,20 @@ export interface components { * @example bug */ name: string; - /** @example Something isn't working */ + /** + * @description Optional description of the label, such as its purpose. + * @example Something isn't working + */ description: string | null; /** * @description 6-character hex code, without the leading #, identifying the color * @example FFFFFF */ color: string; - /** @example true */ + /** + * @description Whether this label comes by default in a new repository. + * @example true + */ default: boolean; }; /** @@ -21879,6 +23891,7 @@ export interface components { reason: string; signature: string | null; payload: string | null; + verified_at?: string | null; }; /** Format: uri */ html_url: string; @@ -21944,11 +23957,13 @@ export interface components { */ url: string; /** + * Format: int64 * @description The ID of the pull request review to which the comment belongs. * @example 42 */ pull_request_review_id: number | null; /** + * Format: int64 * @description The ID of the pull request review comment. * @example 1 */ @@ -21969,12 +23984,12 @@ export interface components { */ path: string; /** - * @description The line index in the diff to which the comment applies. This field is deprecated; use `line` instead. + * @description The line index in the diff to which the comment applies. This field is closing down; use `line` instead. * @example 1 */ position?: number; /** - * @description The index of the original line in the diff to which the comment applies. This field is deprecated; use `original_line` instead. + * @description The index of the original line in the diff to which the comment applies. This field is closing down; use `original_line` instead. * @example 4 */ original_position?: number; @@ -22196,6 +24211,7 @@ export interface components { read_only: boolean; added_by?: string | null; last_used?: string | null; + enabled?: boolean; }; /** * Language @@ -22567,7 +24583,10 @@ export interface components { * @example https://api.github.com/repos/octocat/Hello-World/pulls/1347 */ url: string; - /** @example 1 */ + /** + * Format: int64 + * @example 1 + */ id: number; /** @example MDExOlB1bGxSZXF1ZXN0MQ== */ node_id: string; @@ -22676,359 +24695,16 @@ export interface components { head: { label: string; ref: string; - repo: { - archive_url: string; - assignees_url: string; - blobs_url: string; - branches_url: string; - collaborators_url: string; - comments_url: string; - commits_url: string; - compare_url: string; - contents_url: string; - /** Format: uri */ - contributors_url: string; - /** Format: uri */ - deployments_url: string; - description: string | null; - /** Format: uri */ - downloads_url: string; - /** Format: uri */ - events_url: string; - fork: boolean; - /** Format: uri */ - forks_url: string; - full_name: string; - git_commits_url: string; - git_refs_url: string; - git_tags_url: string; - /** Format: uri */ - hooks_url: string; - /** Format: uri */ - html_url: string; - id: number; - node_id: string; - issue_comment_url: string; - issue_events_url: string; - issues_url: string; - keys_url: string; - labels_url: string; - /** Format: uri */ - languages_url: string; - /** Format: uri */ - merges_url: string; - milestones_url: string; - name: string; - notifications_url: string; - owner: { - /** Format: uri */ - avatar_url: string; - events_url: string; - /** Format: uri */ - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string | null; - /** Format: uri */ - html_url: string; - id: number; - node_id: string; - login: string; - /** Format: uri */ - organizations_url: string; - /** Format: uri */ - received_events_url: string; - /** Format: uri */ - repos_url: string; - site_admin: boolean; - starred_url: string; - /** Format: uri */ - subscriptions_url: string; - type: string; - /** Format: uri */ - url: string; - }; - private: boolean; - pulls_url: string; - releases_url: string; - /** Format: uri */ - stargazers_url: string; - statuses_url: string; - /** Format: uri */ - subscribers_url: string; - /** Format: uri */ - subscription_url: string; - /** Format: uri */ - tags_url: string; - /** Format: uri */ - teams_url: string; - trees_url: string; - /** Format: uri */ - url: string; - clone_url: string; - default_branch: string; - forks: number; - forks_count: number; - git_url: string; - has_downloads: boolean; - has_issues: boolean; - has_projects: boolean; - has_wiki: boolean; - has_pages: boolean; - has_discussions: boolean; - /** Format: uri */ - homepage: string | null; - language: string | null; - master_branch?: string; - archived: boolean; - disabled: boolean; - /** @description The repository visibility: public, private, or internal. */ - visibility?: string; - /** Format: uri */ - mirror_url: string | null; - open_issues: number; - open_issues_count: number; - permissions?: { - admin: boolean; - maintain?: boolean; - push: boolean; - triage?: boolean; - pull: boolean; - }; - temp_clone_token?: string; - allow_merge_commit?: boolean; - allow_squash_merge?: boolean; - allow_rebase_merge?: boolean; - license: { - key: string; - name: string; - /** Format: uri */ - url: string | null; - spdx_id: string | null; - node_id: string; - } | null; - /** Format: date-time */ - pushed_at: string; - size: number; - ssh_url: string; - stargazers_count: number; - /** Format: uri */ - svn_url: string; - topics?: string[]; - watchers: number; - watchers_count: number; - /** Format: date-time */ - created_at: string; - /** Format: date-time */ - updated_at: string; - allow_forking?: boolean; - is_template?: boolean; - web_commit_signoff_required?: boolean; - } | null; + repo: components["schemas"]["repository"]; sha: string; - user: { - /** Format: uri */ - avatar_url: string; - events_url: string; - /** Format: uri */ - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string | null; - /** Format: uri */ - html_url: string; - id: number; - node_id: string; - login: string; - /** Format: uri */ - organizations_url: string; - /** Format: uri */ - received_events_url: string; - /** Format: uri */ - repos_url: string; - site_admin: boolean; - starred_url: string; - /** Format: uri */ - subscriptions_url: string; - type: string; - /** Format: uri */ - url: string; - }; + user: components["schemas"]["simple-user"]; }; base: { label: string; ref: string; - repo: { - archive_url: string; - assignees_url: string; - blobs_url: string; - branches_url: string; - collaborators_url: string; - comments_url: string; - commits_url: string; - compare_url: string; - contents_url: string; - /** Format: uri */ - contributors_url: string; - /** Format: uri */ - deployments_url: string; - description: string | null; - /** Format: uri */ - downloads_url: string; - /** Format: uri */ - events_url: string; - fork: boolean; - /** Format: uri */ - forks_url: string; - full_name: string; - git_commits_url: string; - git_refs_url: string; - git_tags_url: string; - /** Format: uri */ - hooks_url: string; - /** Format: uri */ - html_url: string; - id: number; - is_template?: boolean; - node_id: string; - issue_comment_url: string; - issue_events_url: string; - issues_url: string; - keys_url: string; - labels_url: string; - /** Format: uri */ - languages_url: string; - /** Format: uri */ - merges_url: string; - milestones_url: string; - name: string; - notifications_url: string; - owner: { - /** Format: uri */ - avatar_url: string; - events_url: string; - /** Format: uri */ - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string | null; - /** Format: uri */ - html_url: string; - id: number; - node_id: string; - login: string; - /** Format: uri */ - organizations_url: string; - /** Format: uri */ - received_events_url: string; - /** Format: uri */ - repos_url: string; - site_admin: boolean; - starred_url: string; - /** Format: uri */ - subscriptions_url: string; - type: string; - /** Format: uri */ - url: string; - }; - private: boolean; - pulls_url: string; - releases_url: string; - /** Format: uri */ - stargazers_url: string; - statuses_url: string; - /** Format: uri */ - subscribers_url: string; - /** Format: uri */ - subscription_url: string; - /** Format: uri */ - tags_url: string; - /** Format: uri */ - teams_url: string; - trees_url: string; - /** Format: uri */ - url: string; - clone_url: string; - default_branch: string; - forks: number; - forks_count: number; - git_url: string; - has_downloads: boolean; - has_issues: boolean; - has_projects: boolean; - has_wiki: boolean; - has_pages: boolean; - has_discussions: boolean; - /** Format: uri */ - homepage: string | null; - language: string | null; - master_branch?: string; - archived: boolean; - disabled: boolean; - /** @description The repository visibility: public, private, or internal. */ - visibility?: string; - /** Format: uri */ - mirror_url: string | null; - open_issues: number; - open_issues_count: number; - permissions?: { - admin: boolean; - maintain?: boolean; - push: boolean; - triage?: boolean; - pull: boolean; - }; - temp_clone_token?: string; - allow_merge_commit?: boolean; - allow_squash_merge?: boolean; - allow_rebase_merge?: boolean; - license: components["schemas"]["nullable-license-simple"]; - /** Format: date-time */ - pushed_at: string; - size: number; - ssh_url: string; - stargazers_count: number; - /** Format: uri */ - svn_url: string; - topics?: string[]; - watchers: number; - watchers_count: number; - /** Format: date-time */ - created_at: string; - /** Format: date-time */ - updated_at: string; - allow_forking?: boolean; - web_commit_signoff_required?: boolean; - }; + repo: components["schemas"]["repository"]; sha: string; - user: { - /** Format: uri */ - avatar_url: string; - events_url: string; - /** Format: uri */ - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string | null; - /** Format: uri */ - html_url: string; - id: number; - node_id: string; - login: string; - /** Format: uri */ - organizations_url: string; - /** Format: uri */ - received_events_url: string; - /** Format: uri */ - repos_url: string; - site_admin: boolean; - starred_url: string; - /** Format: uri */ - subscriptions_url: string; - type: string; - /** Format: uri */ - url: string; - }; + user: components["schemas"]["simple-user"]; }; _links: { comments: components["schemas"]["link"]; @@ -23096,6 +24772,7 @@ export interface components { */ "pull-request-review": { /** + * Format: int64 * @description Unique identifier of the review * @example 42 */ @@ -23149,9 +24826,15 @@ export interface components { * @example https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 */ url: string; - /** @example 42 */ + /** + * Format: int64 + * @example 42 + */ pull_request_review_id: number | null; - /** @example 10 */ + /** + * Format: int64 + * @example 10 + */ id: number; /** @example MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw */ node_id: string; @@ -23362,6 +25045,8 @@ export interface components { components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-required-linear-history"] & components["schemas"]["repository-rule-ruleset-info"]) + | (components["schemas"]["repository-rule-merge-queue"] & + components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-required-deployments"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-required-signatures"] & @@ -23383,6 +25068,8 @@ export interface components { | (components["schemas"]["repository-rule-tag-name-pattern"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-workflows"] & + components["schemas"]["repository-rule-ruleset-info"]) + | (components["schemas"]["repository-rule-code-scanning"] & components["schemas"]["repository-rule-ruleset-info"]); "secret-scanning-alert": { number?: components["schemas"]["alert-number"]; @@ -23409,7 +25096,7 @@ export interface components { 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)." + * For a list of built-in patterns, see "[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)." */ secret_type_display_name?: string; /** @description The secret that was detected. */ @@ -23422,11 +25109,25 @@ export interface components { * @description The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ push_protection_bypassed_at?: string | null; + push_protection_bypass_request_reviewer?: components["schemas"]["nullable-simple-user"]; + /** @description An optional comment when reviewing a push protection bypass. */ + push_protection_bypass_request_reviewer_comment?: string | null; + /** @description An optional comment when requesting a push protection bypass. */ + push_protection_bypass_request_comment?: string | null; + /** + * Format: uri + * @description The URL to a push protection bypass request. + */ + push_protection_bypass_request_html_url?: string | null; /** * @description The token status as of the latest validity check. * @enum {string} */ validity?: "active" | "inactive" | "unknown"; + /** @description Whether the detected secret was publicly leaked. */ + publicly_leaked?: boolean | null; + /** @description Whether the detected secret was found in multiple repositories under the same organization or enterprise. */ + multi_repo?: boolean | null; }; /** @description An optional comment when closing an alert. Cannot be updated or deleted. Must be `null` when changing `state` to `open`. */ "secret-scanning-alert-resolution-comment": string | null; @@ -23555,7 +25256,7 @@ export interface components { /** * Format: uri * @description The API URL to get the pull request where the secret was detected. - * @example https://api.github.com/repos/octocat/Hello-World/pull/2846 + * @example https://api.github.com/repos/octocat/Hello-World/pulls/2846 */ pull_request_title_url: string; }; @@ -23564,7 +25265,7 @@ export interface components { /** * Format: uri * @description The API URL to get the pull request where the secret was detected. - * @example https://api.github.com/repos/octocat/Hello-World/pull/2846 + * @example https://api.github.com/repos/octocat/Hello-World/pulls/2846 */ pull_request_body_url: string; }; @@ -23630,6 +25331,52 @@ export interface components { | components["schemas"]["secret-scanning-location-pull-request-review"] | components["schemas"]["secret-scanning-location-pull-request-review-comment"]; }; + /** + * @description The reason for bypassing push protection. + * @enum {string} + */ + "secret-scanning-push-protection-bypass-reason": + | "false_positive" + | "used_in_tests" + | "will_fix_later"; + "secret-scanning-push-protection-bypass": { + reason?: components["schemas"]["secret-scanning-push-protection-bypass-reason"]; + /** + * Format: date-time + * @description The time that the bypass will expire in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + expire_at?: string | null; + /** @description The token type this bypass is for. */ + token_type?: string; + }; + /** @description Information on a single scan performed by secret scanning on the repository */ + "secret-scanning-scan": { + /** @description The type of scan */ + type?: string; + /** @description The state of the scan. Either "completed", "running", or "pending" */ + status?: string; + /** + * Format: date-time + * @description The time that the scan was completed. Empty if the scan is running + */ + completed_at?: string | null; + /** + * Format: date-time + * @description The time that the scan was started. Empty if the scan is pending + */ + started_at?: string | null; + }; + "secret-scanning-scan-history": { + incremental_scans?: components["schemas"]["secret-scanning-scan"][]; + pattern_update_scans?: components["schemas"]["secret-scanning-scan"][]; + backfill_scans?: components["schemas"]["secret-scanning-scan"][]; + custom_pattern_backfill_scans?: (components["schemas"]["secret-scanning-scan"] & { + /** @description Name of the custom pattern for custom pattern scans */ + pattern_name?: string; + /** @description Level at which the custom pattern is defined, one of "repository", "organization", or "enterprise" */ + pattern_scope?: string; + })[]; + }; "repository-advisory-create": { /** @description A short summary of the advisory. */ summary: string; @@ -24076,6 +25823,12 @@ export interface components { default?: boolean; description?: string | null; }[]; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; state: string; state_reason?: string | null; assignee: components["schemas"]["nullable-simple-user"]; @@ -24302,6 +26055,7 @@ export interface components { */ "user-search-result-item": { login: string; + /** Format: int64 */ id: number; node_id: string; /** Format: uri */ @@ -24347,6 +26101,7 @@ export interface components { company?: string | null; /** Format: date-time */ suspended_at?: string | null; + user_view_type?: string; }; /** * Private User @@ -24355,8 +26110,12 @@ export interface components { "private-user": { /** @example octocat */ login: string; - /** @example 1 */ + /** + * Format: int64 + * @example 1 + */ id: number; + user_view_type?: string; /** @example MDQ6VXNlcjE= */ node_id: string; /** @@ -24425,6 +26184,11 @@ export interface components { * @example octocat@github.com */ email: string | null; + /** + * Format: email + * @example octocat@github.com + */ + notification_email?: string | null; hireable: boolean | null; /** @example There once was... */ bio: string | null; @@ -24466,8 +26230,6 @@ export interface components { space: number; private_repos: number; }; - /** Format: date-time */ - suspended_at?: string | null; business_plus?: boolean; ldap_dn?: string; }; @@ -24566,7 +26328,10 @@ export interface components { * @description A codespace. */ "codespace-with-full-repository": { - /** @example 1 */ + /** + * Format: int64 + * @example 1 + */ id: number; /** * @description Automatically generated name of this codespace. @@ -24749,7 +26514,10 @@ export interface components { * @description A unique encryption key */ "gpg-key": { - /** @example 3 */ + /** + * Format: int64 + * @example 3 + */ id: number; /** @example Octocat's GPG Key */ name?: string | null; @@ -24789,6 +26557,7 @@ export interface components { * ] */ subkeys: { + /** Format: int64 */ id?: number; primary_key_id?: number; key_id?: string; @@ -24830,6 +26599,7 @@ export interface components { */ key: { key: string; + /** Format: int64 */ id: number; url: string; title: string; @@ -24909,6 +26679,45 @@ export interface components { starred_at: string; repo: components["schemas"]["repository"]; }; + /** + * Sigstore Bundle v0.1 + * @description Sigstore Bundle v0.1 + */ + "sigstore-bundle-0": { + mediaType?: string; + verificationMaterial?: { + x509CertificateChain?: { + certificates?: { + rawBytes?: string; + }[]; + }; + tlogEntries?: { + logIndex?: string; + logId?: { + keyId?: string; + }; + kindVersion?: { + kind?: string; + version?: string; + }; + integratedTime?: string; + inclusionPromise?: { + signedEntryTimestamp?: string; + }; + inclusionProof?: string | null; + canonicalizedBody?: string; + }[]; + timestampVerificationData?: string | null; + }; + dsseEnvelope?: { + payload?: string; + payloadType?: string; + signatures?: { + sig?: string; + keyid?: string; + }[]; + }; + }; /** * Hovercard * @description Hovercard @@ -25041,6 +26850,7 @@ export interface components { */ "repository-webhooks": { /** + * Format: int64 * @description Unique identifier of the repository * @example 42 */ @@ -25480,7 +27290,7 @@ export interface components { 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. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -25541,75 +27351,6 @@ export interface components { /** @description Whether anonymous git access is enabled for this repository */ anonymous_access_enabled?: boolean; }; - /** - * Simple User - * @description The GitHub user that triggered the event. This property is included in every webhook payload. - */ - "simple-user-webhooks": { - name?: string | null; - email?: string | null; - /** @example octocat */ - login: string; - /** @example 1 */ - id: number; - /** @example MDQ6VXNlcjE= */ - node_id: string; - /** - * Format: uri - * @example https://github.com/images/error/octocat_happy.gif - */ - avatar_url: string; - /** @example 41d064eb2195891e12d0413f63227ea7 */ - gravatar_id: string | null; - /** - * Format: uri - * @example https://api.github.com/users/octocat - */ - url: string; - /** - * Format: uri - * @example https://github.com/octocat - */ - html_url: string; - /** - * Format: uri - * @example https://api.github.com/users/octocat/followers - */ - followers_url: string; - /** @example https://api.github.com/users/octocat/following{/other_user} */ - following_url: string; - /** @example https://api.github.com/users/octocat/gists{/gist_id} */ - gists_url: string; - /** @example https://api.github.com/users/octocat/starred{/owner}{/repo} */ - starred_url: string; - /** - * Format: uri - * @example https://api.github.com/users/octocat/subscriptions - */ - subscriptions_url: string; - /** - * Format: uri - * @example https://api.github.com/users/octocat/orgs - */ - organizations_url: string; - /** - * Format: uri - * @example https://api.github.com/users/octocat/repos - */ - repos_url: string; - /** @example https://api.github.com/users/octocat/events{/privacy} */ - events_url: string; - /** - * Format: uri - * @example https://api.github.com/users/octocat/received_events - */ - received_events_url: string; - /** @example User */ - type: string; - site_admin: boolean; - /** @example "2020-07-09T00:17:55Z" */ - starred_at?: string; - }; /** * branch protection rule * @description The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) applied to branches that match the name. Binary settings are boolean. Multi-level configurations are one of `off`, `non_admins`, or `everyone`. Actor and build lists are arrays of strings. @@ -25634,6 +27375,13 @@ export interface components { | "off" | "non_admins" | "everyone"; + /** + * @description The enforcement level of the branch lock setting. `off` means the branch is not locked, `non_admins` means the branch is read-only for non_admins, and `everyone` means the branch is read-only for everyone. + * @enum {string} + */ + lock_branch_enforcement_level: "off" | "non_admins" | "everyone"; + /** @description Whether users can pull changes from upstream when the branch is locked. Set to `true` to allow users to pull changes from upstream when the branch is locked. This setting is only applicable for forks. */ + lock_allows_fork_sync?: boolean; /** @enum {string} */ merge_queue_enforcement_level: "off" | "non_admins" | "everyone"; name: string; @@ -25806,6 +27554,7 @@ export interface components { /** Format: uri */ url: string; verified: boolean; + enabled?: boolean; }; /** Workflow */ webhooks_workflow: { @@ -25844,6 +27593,7 @@ export interface components { subscriptions_url?: string; type?: string; url?: string; + user_view_type?: string; }; webhooks_reviewers: { /** User */ @@ -25913,6 +27663,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -25932,6 +27683,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; webhooks_answer: { /** @@ -25991,6 +27743,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -26010,6 +27763,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** @@ -26055,6 +27809,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; answer_html_url: string | null; /** @@ -26142,6 +27897,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -26161,7 +27917,9 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; + labels?: components["schemas"]["label"][]; }; webhooks_comment: { /** @@ -26219,6 +27977,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -26238,6 +27997,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Label */ @@ -26355,6 +28115,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -26374,6 +28135,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** @description The changes to the comment. */ @@ -26431,6 +28193,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -26467,6 +28230,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -26562,6 +28326,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -26692,6 +28457,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -26799,6 +28565,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -26833,6 +28605,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -26852,6 +28625,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** @@ -26900,6 +28674,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -26973,6 +28748,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -27009,6 +28785,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -27104,6 +28881,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -27232,6 +29010,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -27339,6 +29118,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -27373,6 +29158,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -27392,6 +29178,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** User */ @@ -27430,6 +29217,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** Marketplace Purchase */ webhooks_marketplace_purchase: { @@ -27571,6 +29359,7 @@ export interface components { */ "nullable-repository-webhooks": { /** + * Format: int64 * @description Unique identifier of the repository * @example 42 */ @@ -28010,7 +29799,7 @@ export interface components { 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. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -28117,6 +29906,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -28170,6 +29960,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -28189,6 +29980,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** @@ -28257,6 +30049,10 @@ export interface components { | null; /** @description Date and time when the request for access was created. */ created_at: string; + /** @description Unique identifier of the user's token. This field can also be found in audit log events and the organization's settings for their PAT grants. */ + token_id: number; + /** @description The name given to the user's token. This field can also be found in an organization's settings page for Active Tokens. */ + token_name: string; /** @description Whether the associated fine-grained personal access token has expired. */ token_expired: boolean; /** @description Date and time when the associated fine-grained personal access token expires. */ @@ -28312,6 +30108,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The project card's ID */ id: number; @@ -28368,6 +30165,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** Format: uri */ html_url: string; @@ -28484,6 +30282,69 @@ export interface components { */ archived_at: string | null; }; + /** + * Projects v2 Single Select Option + * @description An option for a single select field + */ + "projects-v2-single-select-option": { + id: string; + name: string; + color?: string | null; + description?: string | null; + }; + /** + * Projects v2 Iteration Setting + * @description An iteration setting for an iteration field + */ + "projects-v2-iteration-setting": { + id: string; + title: string; + duration?: number | null; + start_date?: string | null; + }; + /** + * Projects v2 Status Update + * @description An status update belonging to a project + */ + "projects-v2-status-update": { + id: number; + node_id: string; + project_node_id?: string; + creator?: components["schemas"]["simple-user"]; + /** + * Format: date-time + * @example 2022-04-28T12:00:00Z + */ + created_at: string; + /** + * Format: date-time + * @example 2022-04-28T12:00:00Z + */ + updated_at: string; + /** @enum {string|null} */ + status?: + | "INACTIVE" + | "ON_TRACK" + | "AT_RISK" + | "OFF_TRACK" + | "COMPLETE" + | null; + /** + * Format: date + * @example 2022-04-28 + */ + start_date?: string; + /** + * Format: date + * @example 2022-04-28 + */ + target_date?: string; + /** + * @description Body of the status update + * @example The project is off to a great start! + */ + body?: string | null; + }; /** @description The pull request number. */ webhooks_number: number; "pull-request-webhook": components["schemas"]["pull-request"] & { @@ -28530,7 +30391,7 @@ export interface components { */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; /** - * @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.** + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.** * @default false */ use_squash_pr_title_as_default?: boolean; @@ -28623,6 +30484,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -28719,6 +30581,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -28846,7 +30709,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -28939,6 +30805,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -29028,6 +30895,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -29047,6 +30915,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -29186,7 +31055,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -29279,6 +31151,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -29368,6 +31241,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -29387,6 +31261,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -29454,6 +31329,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Milestone @@ -29501,6 +31377,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -29709,6 +31586,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -29728,6 +31606,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** @@ -29862,6 +31741,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -29881,6 +31761,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** @description The review that was affected. */ @@ -29942,6 +31823,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -29961,6 +31843,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; webhooks_nullable_string: string | null; @@ -30067,6 +31950,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; body: string | null; /** Format: date-time */ @@ -30214,6 +32098,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; body: string | null; /** Format: date-time */ @@ -30354,6 +32239,11 @@ 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 "[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)." + */ + secret_type_display_name?: string; /** * @description The token status as of the latest validity check. * @enum {string} @@ -30367,6 +32257,20 @@ export interface components { * @description The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ push_protection_bypassed_at?: string | null; + push_protection_bypass_request_reviewer?: components["schemas"]["nullable-simple-user"]; + /** @description An optional comment when reviewing a push protection bypass. */ + push_protection_bypass_request_reviewer_comment?: string | null; + /** @description An optional comment when requesting a push protection bypass. */ + push_protection_bypass_request_comment?: string | null; + /** + * Format: uri + * @description The URL to a push protection bypass request. + */ + push_protection_bypass_request_html_url?: string | null; + /** @description Whether the detected secret was publicly leaked. */ + publicly_leaked?: boolean | null; + /** @description Whether the detected secret was found in multiple repositories in the same organization or business. */ + multi_repo?: boolean | null; }; /** @description The details of the security advisory, including summary, description, and severity. */ webhooks_security_advisory: { @@ -30374,6 +32278,7 @@ export interface components { score: number; vector_string: string | null; }; + cvss_severities?: components["schemas"]["cvss-severities"]; cwes: { cwe_id: string; name: string; @@ -30426,6 +32331,7 @@ export interface components { subscriptions_url?: string; type?: string; url?: string; + user_view_type?: string; }; node_id: string; privacy_level: string; @@ -30465,6 +32371,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** User */ sponsorable: { @@ -30502,6 +32409,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Sponsorship Tier @@ -30615,7 +32523,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** branch protection configuration enabled event */ "webhook-branch-protection-configuration-enabled": { @@ -30625,7 +32533,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** branch protection rule created event */ "webhook-branch-protection-rule-created": { @@ -30636,7 +32544,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; rule: components["schemas"]["webhooks_rule"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** branch protection rule deleted event */ "webhook-branch-protection-rule-deleted": { @@ -30647,7 +32555,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; rule: components["schemas"]["webhooks_rule"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** branch protection rule edited event */ "webhook-branch-protection-rule-edited": { @@ -30671,6 +32579,20 @@ export interface components { /** @enum {string} */ from: "off" | "non_admins" | "everyone"; }; + lock_branch_enforcement_level?: { + /** @enum {string} */ + from: "off" | "non_admins" | "everyone"; + }; + lock_allows_fork_sync?: { + from: boolean | null; + }; + pull_request_reviews_enforcement_level?: { + /** @enum {string} */ + from: "off" | "non_admins" | "everyone"; + }; + require_last_push_approval?: { + from: boolean | null; + }; required_status_checks?: { from: string[]; }; @@ -30684,7 +32606,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; rule: components["schemas"]["webhooks_rule"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Check Run Completed Event */ "webhook-check-run-completed": { @@ -30694,7 +32616,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** * Check Run Completed Event @@ -30712,7 +32634,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** * Check Run Created Event @@ -30735,7 +32657,7 @@ export interface components { /** @description The integrator reference of the action requested by the user. */ identifier?: string; }; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** * Check Run Requested Action Event @@ -30753,7 +32675,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** * Check Run Re-Requested Event @@ -30839,6 +32761,8 @@ export interface components { html_url: string; /** @description Unique identifier of the GitHub app */ id: number | null; + /** @description The client ID of the GitHub app */ + client_id?: string | null; /** @description The name of the GitHub app */ name: string; node_id: string; @@ -30878,6 +32802,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -31071,7 +32996,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** check_suite requested event */ "webhook-check-suite-requested": { @@ -31150,6 +33075,8 @@ export interface components { html_url: string; /** @description Unique identifier of the GitHub app */ id: number | null; + /** @description Client ID of the GitHub app */ + client_id?: string | null; /** @description The name of the GitHub app */ name: string; node_id: string; @@ -31189,6 +33116,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -31375,7 +33303,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** check_suite rerequested event */ "webhook-check-suite-rerequested": { @@ -31449,6 +33377,8 @@ export interface components { html_url: string; /** @description Unique identifier of the GitHub app */ id: number | null; + /** @description The Client ID for the GitHub app */ + client_id?: string | null; /** @description The name of the GitHub app */ name: string; node_id: string; @@ -31488,6 +33418,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -31673,7 +33604,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** code_scanning_alert appeared_in_branch event */ "webhook-code-scanning-alert-appeared-in-branch": { @@ -31727,6 +33658,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The reason for dismissing or closing the alert. @@ -31803,7 +33735,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; ref: components["schemas"]["webhooks_code_scanning_ref"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** code_scanning_alert closed_by_user event */ "webhook-code-scanning-alert-closed-by-user": { @@ -31857,6 +33789,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The reason for dismissing or closing the alert. @@ -31940,7 +33873,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; ref: components["schemas"]["webhooks_code_scanning_ref"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** code_scanning_alert created event */ "webhook-code-scanning-alert-created": { @@ -32015,9 +33948,9 @@ export interface components { }; /** * @description State of a code scanning alert. - * @enum {string} + * @enum {string|null} */ - state: "open" | "dismissed"; + state: "open" | "dismissed" | null; tool: { guid?: string | null; /** @description The name of the tool used to generate the code scanning analysis alert. */ @@ -32035,7 +33968,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; ref: components["schemas"]["webhooks_code_scanning_ref"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** code_scanning_alert fixed event */ "webhook-code-scanning-alert-fixed": { @@ -32089,6 +34022,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The reason for dismissing or closing the alert. @@ -32174,7 +34108,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; ref: components["schemas"]["webhooks_code_scanning_ref"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** code_scanning_alert reopened event */ "webhook-code-scanning-alert-reopened": { @@ -32267,7 +34201,7 @@ export interface components { /** @description The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. */ ref: string | null; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** code_scanning_alert reopened_by_user event */ "webhook-code-scanning-alert-reopened-by-user": { @@ -32351,7 +34285,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; ref: components["schemas"]["webhooks_code_scanning_ref"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** commit_comment created event */ "webhook-commit-comment-created": { @@ -32360,7 +34294,7 @@ export interface components { * @enum {string} */ action: "created"; - /** @description The [commit comment](https://docs.github.com/rest/commits/comments#get-a-commit-comment) resource. */ + /** @description The [commit comment](${externalDocsUpapp/api/description/components/schemas/webhooks/issue-comment-created.yamlrl}/rest/commits/comments#get-a-commit-comment) resource. */ comment: { /** * AuthorAssociation @@ -32427,6 +34361,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -32446,13 +34381,14 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** create event */ "webhook-create": { @@ -32471,17 +34407,17 @@ export interface components { */ ref_type: "tag" | "branch"; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** custom property created event */ "webhook-custom-property-created": { /** @enum {string} */ action: "created"; - definition: components["schemas"]["org-custom-property"]; + definition: components["schemas"]["custom-property"]; enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; - organization: components["schemas"]["organization-simple-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** custom property deleted event */ "webhook-custom-property-deleted": { @@ -32493,18 +34429,18 @@ export interface components { }; enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; - organization: components["schemas"]["organization-simple-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** custom property updated event */ "webhook-custom-property-updated": { /** @enum {string} */ action: "updated"; - definition: components["schemas"]["org-custom-property"]; + definition: components["schemas"]["custom-property"]; enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; - organization: components["schemas"]["organization-simple-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** Custom property values updated event */ "webhook-custom-property-values-updated": { @@ -32514,7 +34450,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; repository: components["schemas"]["repository-webhooks"]; organization: components["schemas"]["organization-simple-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; /** @description The new custom property values for the repository. */ new_property_values: components["schemas"]["custom-property-value"][]; /** @description The old custom property values for the repository. */ @@ -32533,7 +34469,7 @@ export interface components { */ ref_type: "tag" | "branch"; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Dependabot alert auto-dismissed event */ "webhook-dependabot-alert-auto-dismissed": { @@ -32544,7 +34480,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; enterprise?: components["schemas"]["enterprise-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Dependabot alert auto-reopened event */ "webhook-dependabot-alert-auto-reopened": { @@ -32555,7 +34491,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; enterprise?: components["schemas"]["enterprise-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Dependabot alert created event */ "webhook-dependabot-alert-created": { @@ -32566,7 +34502,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; enterprise?: components["schemas"]["enterprise-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Dependabot alert dismissed event */ "webhook-dependabot-alert-dismissed": { @@ -32577,7 +34513,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; enterprise?: components["schemas"]["enterprise-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Dependabot alert fixed event */ "webhook-dependabot-alert-fixed": { @@ -32588,7 +34524,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; enterprise?: components["schemas"]["enterprise-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Dependabot alert reintroduced event */ "webhook-dependabot-alert-reintroduced": { @@ -32599,7 +34535,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; enterprise?: components["schemas"]["enterprise-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Dependabot alert reopened event */ "webhook-dependabot-alert-reopened": { @@ -32610,7 +34546,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; enterprise?: components["schemas"]["enterprise-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** deploy_key created event */ "webhook-deploy-key-created": { @@ -32621,7 +34557,7 @@ export interface components { key: components["schemas"]["webhooks_deploy_key"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** deploy_key deleted event */ "webhook-deploy-key-deleted": { @@ -32632,7 +34568,7 @@ export interface components { key: components["schemas"]["webhooks_deploy_key"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** deployment created event */ "webhook-deployment-created": { @@ -32680,6 +34616,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; environment: string; @@ -32793,6 +34730,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -32889,7 +34827,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; workflow: components["schemas"]["webhooks_workflow"]; /** Deployment Workflow Run */ workflow_run: { @@ -32929,6 +34867,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; artifacts_url?: string; cancel_url?: string; @@ -33179,6 +35118,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** Format: date-time */ updated_at: string; @@ -33206,7 +35146,7 @@ export interface components { repository?: components["schemas"]["repository-webhooks"]; organization?: components["schemas"]["organization-simple-webhooks"]; installation?: components["schemas"]["simple-installation"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; "webhook-deployment-review-approved": { /** @enum {string} */ @@ -33218,7 +35158,7 @@ export interface components { organization: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; reviewers?: components["schemas"]["webhooks_reviewers"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; since: string; workflow_job_run?: components["schemas"]["webhooks_workflow_job_run"]; workflow_job_runs?: { @@ -33269,6 +35209,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; artifacts_url?: string; cancel_url?: string; @@ -33345,6 +35286,7 @@ export interface components { subscriptions_url?: string; type?: string; url?: string; + user_view_type?: string; }; private?: boolean; pulls_url?: string; @@ -33457,6 +35399,7 @@ export interface components { subscriptions_url?: string; type?: string; url?: string; + user_view_type?: string; }; private?: boolean; pulls_url?: string; @@ -33519,6 +35462,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** Format: date-time */ updated_at: string; @@ -33538,7 +35482,7 @@ export interface components { organization: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; reviewers?: components["schemas"]["webhooks_reviewers"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; since: string; workflow_job_run?: components["schemas"]["webhooks_workflow_job_run"]; workflow_job_runs?: { @@ -33589,6 +35533,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; artifacts_url?: string; cancel_url?: string; @@ -33664,6 +35609,7 @@ export interface components { subscriptions_url?: string; type?: string; url?: string; + user_view_type?: string; }; private?: boolean; pulls_url?: string; @@ -33776,6 +35722,7 @@ export interface components { subscriptions_url?: string; type?: string; url?: string; + user_view_type?: string; }; private?: boolean; pulls_url?: string; @@ -33837,6 +35784,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** Format: date-time */ updated_at: string; @@ -33893,11 +35841,12 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @enum {string} */ type?: "User" | "Team"; }[]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; since: string; workflow_job_run: { conclusion: unknown; @@ -33947,6 +35896,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; artifacts_url?: string; cancel_url?: string; @@ -34022,6 +35972,7 @@ export interface components { subscriptions_url?: string; type?: string; url?: string; + user_view_type?: string; }; private?: boolean; pulls_url?: string; @@ -34134,6 +36085,7 @@ export interface components { subscriptions_url?: string; type?: string; url?: string; + user_view_type?: string; }; private?: boolean; pulls_url?: string; @@ -34196,6 +36148,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** Format: date-time */ updated_at: string; @@ -34291,6 +36244,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; environment: string; @@ -34404,6 +36358,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -34535,6 +36490,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** Format: uri */ deployment_url: string; @@ -34653,6 +36609,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -34746,7 +36703,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; workflow?: components["schemas"]["webhooks_workflow"]; /** Deployment Workflow Run */ workflow_run?: { @@ -34786,6 +36743,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; artifacts_url?: string; cancel_url?: string; @@ -35037,6 +36995,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** Format: date-time */ updated_at: string; @@ -35056,7 +37015,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion category changed event */ "webhook-discussion-category-changed": { @@ -35084,7 +37043,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion closed event */ "webhook-discussion-closed": { @@ -35095,7 +37054,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion_comment created event */ "webhook-discussion-comment-created": { @@ -35107,7 +37066,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion_comment deleted event */ "webhook-discussion-comment-deleted": { @@ -35119,7 +37078,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion_comment edited event */ "webhook-discussion-comment-edited": { @@ -35136,7 +37095,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion created event */ "webhook-discussion-created": { @@ -35147,7 +37106,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion deleted event */ "webhook-discussion-deleted": { @@ -35158,7 +37117,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion edited event */ "webhook-discussion-edited": { @@ -35177,7 +37136,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion labeled event */ "webhook-discussion-labeled": { @@ -35189,7 +37148,7 @@ export interface components { label: components["schemas"]["webhooks_label"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion locked event */ "webhook-discussion-locked": { @@ -35200,7 +37159,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion pinned event */ "webhook-discussion-pinned": { @@ -35211,7 +37170,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion reopened event */ "webhook-discussion-reopened": { @@ -35222,7 +37181,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion transferred event */ "webhook-discussion-transferred": { @@ -35237,7 +37196,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion unanswered event */ "webhook-discussion-unanswered": { @@ -35247,7 +37206,7 @@ export interface components { old_answer: components["schemas"]["webhooks_answer"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** discussion unlabeled event */ "webhook-discussion-unlabeled": { @@ -35259,7 +37218,7 @@ export interface components { label: components["schemas"]["webhooks_label"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion unlocked event */ "webhook-discussion-unlocked": { @@ -35270,7 +37229,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion unpinned event */ "webhook-discussion-unpinned": { @@ -35281,7 +37240,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** * fork event @@ -35342,10 +37301,6 @@ export interface components { /** Format: uri */ contributors_url: string; created_at: number | 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?: { - [key: string]: unknown; - }; /** @description The default branch of the repository. */ default_branch: string; /** @@ -35402,7 +37357,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -35478,6 +37436,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -35629,13 +37588,13 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** github_app_authorization revoked event */ "webhook-github-app-authorization-revoked": { /** @enum {string} */ action: "revoked"; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** gollum event */ "webhook-gollum": { @@ -35663,7 +37622,7 @@ export interface components { title: string; }[]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** installation created event */ "webhook-installation-created": { @@ -35675,7 +37634,7 @@ export interface components { repositories?: components["schemas"]["webhooks_repositories"]; repository?: components["schemas"]["repository-webhooks"]; requester?: components["schemas"]["webhooks_user"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** installation deleted event */ "webhook-installation-deleted": { @@ -35687,7 +37646,7 @@ export interface components { repositories?: components["schemas"]["webhooks_repositories"]; repository?: components["schemas"]["repository-webhooks"]; requester?: unknown; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** installation new_permissions_accepted event */ "webhook-installation-new-permissions-accepted": { @@ -35699,7 +37658,7 @@ export interface components { repositories?: components["schemas"]["webhooks_repositories"]; repository?: components["schemas"]["repository-webhooks"]; requester?: unknown; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** installation_repositories added event */ "webhook-installation-repositories-added": { @@ -35723,7 +37682,7 @@ export interface components { repository?: components["schemas"]["repository-webhooks"]; repository_selection: components["schemas"]["webhooks_repository_selection"]; requester: components["schemas"]["webhooks_user"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** installation_repositories removed event */ "webhook-installation-repositories-removed": { @@ -35747,7 +37706,7 @@ export interface components { repository?: components["schemas"]["repository-webhooks"]; repository_selection: components["schemas"]["webhooks_repository_selection"]; requester: components["schemas"]["webhooks_user"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** installation suspend event */ "webhook-installation-suspend": { @@ -35759,7 +37718,7 @@ export interface components { repositories?: components["schemas"]["webhooks_repositories"]; repository?: components["schemas"]["repository-webhooks"]; requester?: unknown; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; "webhook-installation-target-renamed": { account: { @@ -35799,6 +37758,7 @@ export interface components { updated_at?: string; url?: string; website_url?: unknown; + user_view_type?: string; }; /** @enum {string} */ action: "renamed"; @@ -35814,7 +37774,7 @@ export interface components { installation: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; target_type: string; }; /** installation unsuspend event */ @@ -35827,7 +37787,7 @@ export interface components { repositories?: components["schemas"]["webhooks_repositories"]; repository?: components["schemas"]["repository-webhooks"]; requester?: unknown; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issue_comment created event */ "webhook-issue-comment-created": { @@ -35905,6 +37865,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -35924,6 +37885,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; enterprise?: components["schemas"]["enterprise-webhooks"]; @@ -35973,6 +37935,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -36009,6 +37972,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -36104,6 +38068,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -36234,6 +38199,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -36341,6 +38307,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -36375,6 +38347,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -36394,6 +38367,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; } & { active_lock_reason?: string | null; @@ -36433,6 +38407,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees?: (Record | null)[]; author_association?: string; @@ -36495,6 +38470,7 @@ export interface components { gists_url?: string; gravatar_id?: string; html_url?: string; + /** Format: int64 */ id?: number; login?: string; node_id?: string; @@ -36510,7 +38486,7 @@ export interface components { }; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issue_comment deleted event */ "webhook-issue-comment-deleted": { @@ -36564,6 +38540,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -36600,6 +38577,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -36695,6 +38673,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -36823,6 +38802,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -36930,6 +38910,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -36964,6 +38950,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -36983,6 +38970,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; } & { active_lock_reason?: string | null; @@ -37022,6 +39010,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees?: (Record | null)[]; author_association?: string; @@ -37084,6 +39073,7 @@ export interface components { gists_url?: string; gravatar_id?: string; html_url?: string; + /** Format: int64 */ id?: number; login?: string; node_id?: string; @@ -37095,11 +39085,12 @@ export interface components { subscriptions_url?: string; type?: string; url?: string; + user_view_type?: string; }; }; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issue_comment edited event */ "webhook-issue-comment-edited": { @@ -37154,6 +39145,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -37190,6 +39182,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -37285,6 +39278,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -37415,6 +39409,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -37522,6 +39517,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -37556,6 +39557,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -37575,6 +39577,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; } & { active_lock_reason?: string | null; @@ -37614,6 +39617,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees?: (Record | null)[]; author_association?: string; @@ -37676,6 +39680,7 @@ export interface components { gists_url?: string; gravatar_id?: string; html_url?: string; + /** Format: int64 */ id?: number; login?: string; node_id?: string; @@ -37691,7 +39696,7 @@ export interface components { }; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues assigned event */ "webhook-issues-assigned": { @@ -37706,7 +39711,7 @@ export interface components { issue: components["schemas"]["webhooks_issue"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues closed event */ "webhook-issues-closed": { @@ -37762,6 +39767,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -37798,6 +39804,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -37893,6 +39900,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -38024,6 +40032,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -38131,6 +40140,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -38165,6 +40180,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -38184,6 +40200,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; } & { active_lock_reason?: string | null; @@ -38232,6 +40249,7 @@ export interface components { gists_url?: string; gravatar_id?: string; html_url?: string; + /** Format: int64 */ id?: number; login?: string; node_id?: string; @@ -38243,11 +40261,12 @@ export interface components { subscriptions_url?: string; type?: string; url?: string; + user_view_type?: string; }; }; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues deleted event */ "webhook-issues-deleted": { @@ -38303,6 +40322,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -38434,6 +40454,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -38563,6 +40584,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -38670,6 +40692,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -38704,6 +40732,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -38723,11 +40752,12 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues demilestoned event */ "webhook-issues-demilestoned": { @@ -38914,6 +40944,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -39042,6 +41073,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -39149,6 +41181,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -39183,6 +41221,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -39202,12 +41241,13 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; milestone?: components["schemas"]["webhooks_milestone"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues edited event */ "webhook-issues-edited": { @@ -39274,6 +41314,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -39405,6 +41446,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -39536,6 +41578,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -39643,6 +41686,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -39677,6 +41726,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -39696,12 +41746,13 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; label?: components["schemas"]["webhooks_label"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues labeled event */ "webhook-issues-labeled": { @@ -39757,6 +41808,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -39888,6 +41940,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -40018,6 +42071,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -40125,6 +42179,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -40159,6 +42219,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -40178,12 +42239,13 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; label?: components["schemas"]["webhooks_label"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues locked event */ "webhook-issues-locked": { @@ -40239,6 +42301,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -40275,6 +42338,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -40371,6 +42435,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -40501,6 +42566,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -40608,6 +42674,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -40642,6 +42714,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -40661,11 +42734,12 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues milestoned event */ "webhook-issues-milestoned": { @@ -40852,6 +42926,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -40981,6 +43056,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -41088,6 +43164,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -41122,6 +43204,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -41141,12 +43224,13 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; milestone: components["schemas"]["webhooks_milestone"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues opened event */ "webhook-issues-opened": { @@ -41201,6 +43285,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -41237,6 +43322,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -41332,6 +43418,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -41460,6 +43547,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -41567,6 +43655,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -41601,6 +43695,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -41620,6 +43715,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; } | null; /** @@ -41740,7 +43836,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -41816,6 +43915,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -41916,6 +44016,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -41952,6 +44053,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -42047,6 +44149,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -42178,6 +44281,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -42285,6 +44389,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -42319,6 +44429,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -42338,11 +44449,12 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues pinned event */ "webhook-issues-pinned": { @@ -42353,7 +44465,7 @@ export interface components { issue: components["schemas"]["webhooks_issue_2"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues reopened event */ "webhook-issues-reopened": { @@ -42540,6 +44652,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -42670,6 +44783,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -42777,6 +44891,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -42811,6 +44931,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -42830,11 +44951,12 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues transferred event */ "webhook-issues-transferred": { @@ -42889,6 +45011,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -42925,6 +45048,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -43020,6 +45144,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -43148,6 +45273,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -43255,6 +45381,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -43289,6 +45421,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -43308,6 +45441,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** @@ -43431,7 +45565,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -43507,6 +45644,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -43562,7 +45700,7 @@ export interface components { issue: components["schemas"]["webhooks_issue_2"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues unassigned event */ "webhook-issues-unassigned": { @@ -43577,7 +45715,7 @@ export interface components { issue: components["schemas"]["webhooks_issue"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues unlabeled event */ "webhook-issues-unlabeled": { @@ -43589,7 +45727,7 @@ export interface components { label?: components["schemas"]["webhooks_label"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues unlocked event */ "webhook-issues-unlocked": { @@ -43645,6 +45783,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -43681,6 +45820,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -43777,6 +45917,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -43905,6 +46046,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ permissions?: { @@ -44012,6 +46154,12 @@ export interface components { }; /** Format: uri */ repository_url: string; + /** Sub-issues Summary */ + sub_issues_summary?: { + total: number; + completed: number; + percent_completed: number; + }; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -44046,6 +46194,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -44065,11 +46214,12 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues unpinned event */ "webhook-issues-unpinned": { @@ -44080,7 +46230,7 @@ export interface components { issue: components["schemas"]["webhooks_issue_2"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** label created event */ "webhook-label-created": { @@ -44091,7 +46241,7 @@ export interface components { label: components["schemas"]["webhooks_label"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** label deleted event */ "webhook-label-deleted": { @@ -44102,7 +46252,7 @@ export interface components { label: components["schemas"]["webhooks_label"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** label edited event */ "webhook-label-edited": { @@ -44128,7 +46278,7 @@ export interface components { label: components["schemas"]["webhooks_label"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** marketplace_purchase cancelled event */ "webhook-marketplace-purchase-cancelled": { @@ -44141,7 +46291,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; previous_marketplace_purchase?: components["schemas"]["webhooks_previous_marketplace_purchase"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** marketplace_purchase changed event */ "webhook-marketplace-purchase-changed": { @@ -44180,7 +46330,7 @@ export interface components { unit_count: number; }; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** marketplace_purchase pending_change event */ "webhook-marketplace-purchase-pending-change": { @@ -44219,7 +46369,7 @@ export interface components { unit_count: number; }; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** marketplace_purchase pending_change_cancelled event */ "webhook-marketplace-purchase-pending-change-cancelled": { @@ -44258,7 +46408,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; previous_marketplace_purchase?: components["schemas"]["webhooks_previous_marketplace_purchase"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** marketplace_purchase purchased event */ "webhook-marketplace-purchase-purchased": { @@ -44271,7 +46421,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; previous_marketplace_purchase?: components["schemas"]["webhooks_previous_marketplace_purchase"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** member added event */ "webhook-member-added": { @@ -44298,7 +46448,7 @@ export interface components { member: components["schemas"]["webhooks_user"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** member edited event */ "webhook-member-edited": { @@ -44320,7 +46470,7 @@ export interface components { member: components["schemas"]["webhooks_user"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** member removed event */ "webhook-member-removed": { @@ -44331,7 +46481,7 @@ export interface components { member: components["schemas"]["webhooks_user"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** membership added event */ "webhook-membership-added": { @@ -44383,6 +46533,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; team: components["schemas"]["webhooks_team"]; }; @@ -44436,6 +46587,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; team: components["schemas"]["webhooks_team"]; }; @@ -44446,7 +46598,7 @@ export interface components { merge_group: components["schemas"]["merge-group"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; "webhook-merge-group-destroyed": { /** @enum {string} */ @@ -44460,7 +46612,7 @@ export interface components { merge_group: components["schemas"]["merge-group"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** meta deleted event */ "webhook-meta-deleted": { @@ -44543,7 +46695,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["nullable-repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** milestone closed event */ "webhook-milestone-closed": { @@ -44554,7 +46706,7 @@ export interface components { milestone: components["schemas"]["webhooks_milestone"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** milestone created event */ "webhook-milestone-created": { @@ -44565,7 +46717,7 @@ export interface components { milestone: components["schemas"]["webhooks_milestone_3"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** milestone deleted event */ "webhook-milestone-deleted": { @@ -44576,7 +46728,7 @@ export interface components { milestone: components["schemas"]["webhooks_milestone"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** milestone edited event */ "webhook-milestone-edited": { @@ -44602,7 +46754,7 @@ export interface components { milestone: components["schemas"]["webhooks_milestone"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** milestone opened event */ "webhook-milestone-opened": { @@ -44613,7 +46765,7 @@ export interface components { milestone: components["schemas"]["webhooks_milestone_3"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** org_block blocked event */ "webhook-org-block-blocked": { @@ -44624,7 +46776,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** org_block unblocked event */ "webhook-org-block-unblocked": { @@ -44635,7 +46787,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** organization deleted event */ "webhook-organization-deleted": { @@ -44646,7 +46798,7 @@ export interface components { membership?: components["schemas"]["webhooks_membership"]; organization: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** organization member_added event */ "webhook-organization-member-added": { @@ -44657,7 +46809,7 @@ export interface components { membership: components["schemas"]["webhooks_membership"]; organization: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** organization member_invited event */ "webhook-organization-member-invited": { @@ -44712,6 +46864,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; login: string | null; node_id: string; @@ -44721,7 +46874,7 @@ export interface components { }; organization: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; user?: components["schemas"]["webhooks_user"]; }; /** organization member_removed event */ @@ -44733,7 +46886,7 @@ export interface components { membership: components["schemas"]["webhooks_membership"]; organization: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** organization renamed event */ "webhook-organization-renamed": { @@ -44749,7 +46902,7 @@ export interface components { membership?: components["schemas"]["webhooks_membership"]; organization: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Ruby Gems metadata */ "webhook-rubygems-metadata": { @@ -44823,6 +46976,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; package_type: string; package_version: { @@ -44862,6 +47016,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; body?: string | Record; body_html?: string; @@ -44999,6 +47154,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; created_at: string; draft: boolean; @@ -45034,7 +47190,7 @@ export interface components { updated_at: string | null; }; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** package updated event */ "webhook-package-updated": { @@ -45089,6 +47245,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; package_type: string; package_version: { @@ -45128,6 +47285,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; body: string; body_html: string; @@ -45199,6 +47357,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; created_at: string; draft: boolean; @@ -45235,7 +47394,7 @@ export interface components { updated_at: string; }; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** page_build event */ "webhook-page-build": { @@ -45283,6 +47442,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; status: string; updated_at: string; @@ -45294,15 +47454,16 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** personal_access_token_request approved event */ "webhook-personal-access-token-request-approved": { /** @enum {string} */ action: "approved"; personal_access_token_request: components["schemas"]["personal-access-token-request"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; organization: components["schemas"]["organization-simple-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; installation: components["schemas"]["simple-installation"]; }; /** personal_access_token_request cancelled event */ @@ -45310,8 +47471,9 @@ export interface components { /** @enum {string} */ action: "cancelled"; personal_access_token_request: components["schemas"]["personal-access-token-request"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; organization: components["schemas"]["organization-simple-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; installation: components["schemas"]["simple-installation"]; }; /** personal_access_token_request created event */ @@ -45319,9 +47481,10 @@ export interface components { /** @enum {string} */ action: "created"; personal_access_token_request: components["schemas"]["personal-access-token-request"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; organization: components["schemas"]["organization-simple-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - installation: components["schemas"]["simple-installation"]; + sender: components["schemas"]["simple-user"]; + installation?: components["schemas"]["simple-installation"]; }; /** personal_access_token_request denied event */ "webhook-personal-access-token-request-denied": { @@ -45329,7 +47492,8 @@ export interface components { action: "denied"; personal_access_token_request: components["schemas"]["personal-access-token-request"]; organization: components["schemas"]["organization-simple-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + sender: components["schemas"]["simple-user"]; installation: components["schemas"]["simple-installation"]; }; "webhook-ping": { @@ -45376,7 +47540,7 @@ export interface components { hook_id?: number; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; /** @description Random string of GitHub zen. */ zen?: string; }; @@ -45399,7 +47563,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; project_card: components["schemas"]["webhooks_project_card"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** project_card created event */ "webhook-project-card-created": { @@ -45410,7 +47574,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; project_card: components["schemas"]["webhooks_project_card"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** project_card deleted event */ "webhook-project-card-deleted": { @@ -45467,6 +47631,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The project card's ID */ id: number; @@ -45480,7 +47645,7 @@ export interface components { url: string; }; repository?: components["schemas"]["nullable-repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** project_card edited event */ "webhook-project-card-edited": { @@ -45496,7 +47661,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; project_card: components["schemas"]["webhooks_project_card"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** project_card moved event */ "webhook-project-card-moved": { @@ -45557,6 +47722,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description The project card's ID */ id: number; @@ -45602,7 +47768,7 @@ export interface components { url?: string; }; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** project closed event */ "webhook-project-closed": { @@ -45613,7 +47779,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; project: components["schemas"]["webhooks_project"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** project_column created event */ "webhook-project-column-created": { @@ -45624,7 +47790,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; project_column: components["schemas"]["webhooks_project_column"]; repository?: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** project_column deleted event */ "webhook-project-column-deleted": { @@ -45635,7 +47801,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; project_column: components["schemas"]["webhooks_project_column"]; repository?: components["schemas"]["nullable-repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** project_column edited event */ "webhook-project-column-edited": { @@ -45651,7 +47817,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; project_column: components["schemas"]["webhooks_project_column"]; repository?: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** project_column moved event */ "webhook-project-column-moved": { @@ -45662,7 +47828,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; project_column: components["schemas"]["webhooks_project_column"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** project created event */ "webhook-project-created": { @@ -45673,7 +47839,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; project: components["schemas"]["webhooks_project"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** project deleted event */ "webhook-project-deleted": { @@ -45684,7 +47850,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; project: components["schemas"]["webhooks_project"]; repository?: components["schemas"]["nullable-repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** project edited event */ "webhook-project-edited": { @@ -45706,7 +47872,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; project: components["schemas"]["webhooks_project"]; repository?: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** project reopened event */ "webhook-project-reopened": { @@ -45717,7 +47883,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; project: components["schemas"]["webhooks_project"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Projects v2 Project Closed Event */ "webhook-projects-v2-project-closed": { @@ -45726,7 +47892,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; projects_v2: components["schemas"]["projects-v2"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** @description A project was created */ "webhook-projects-v2-project-created": { @@ -45735,7 +47901,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; projects_v2: components["schemas"]["projects-v2"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Projects v2 Project Deleted Event */ "webhook-projects-v2-project-deleted": { @@ -45744,7 +47910,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; projects_v2: components["schemas"]["projects-v2"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Projects v2 Project Edited Event */ "webhook-projects-v2-project-edited": { @@ -45771,7 +47937,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; projects_v2: components["schemas"]["projects-v2"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Projects v2 Item Archived Event */ "webhook-projects-v2-item-archived": { @@ -45781,7 +47947,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; projects_v2_item: components["schemas"]["projects-v2-item"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Projects v2 Item Converted Event */ "webhook-projects-v2-item-converted": { @@ -45796,7 +47962,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; projects_v2_item: components["schemas"]["projects-v2-item"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Projects v2 Item Created Event */ "webhook-projects-v2-item-created": { @@ -45805,7 +47971,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; projects_v2_item: components["schemas"]["projects-v2-item"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Projects v2 Item Deleted Event */ "webhook-projects-v2-item-deleted": { @@ -45814,18 +47980,36 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; projects_v2_item: components["schemas"]["projects-v2-item"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Projects v2 Item Edited Event */ "webhook-projects-v2-item-edited": { /** @enum {string} */ action: "edited"; + /** + * @description The changes made to the item may involve modifications in the item's fields and draft issue body. + * It includes altered values for text, number, date, single select, and iteration fields, along with the GraphQL node ID of the changed field. + */ changes?: OneOf< [ { field_value: { field_node_id?: string; field_type?: string; + field_name?: string; + project_number?: number; + from?: + | string + | number + | components["schemas"]["projects-v2-single-select-option"] + | components["schemas"]["projects-v2-iteration-setting"] + | null; + to?: + | string + | number + | components["schemas"]["projects-v2-single-select-option"] + | components["schemas"]["projects-v2-iteration-setting"] + | null; }; }, { @@ -45839,7 +48023,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; projects_v2_item: components["schemas"]["projects-v2-item"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Projects v2 Item Reordered Event */ "webhook-projects-v2-item-reordered": { @@ -45854,7 +48038,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; projects_v2_item: components["schemas"]["projects-v2-item"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Projects v2 Item Restored Event */ "webhook-projects-v2-item-restored": { @@ -45864,7 +48048,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; projects_v2_item: components["schemas"]["projects-v2-item"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Projects v2 Project Reopened Event */ "webhook-projects-v2-project-reopened": { @@ -45873,7 +48057,70 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; projects_v2: components["schemas"]["projects-v2"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; + }; + /** Projects v2 Status Update Created Event */ + "webhook-projects-v2-status-update-created": { + /** @enum {string} */ + action: "created"; + installation?: components["schemas"]["simple-installation"]; + organization: components["schemas"]["organization-simple-webhooks"]; + projects_v2_status_update: components["schemas"]["projects-v2-status-update"]; + sender: components["schemas"]["simple-user"]; + }; + /** Projects v2 Status Update Deleted Event */ + "webhook-projects-v2-status-update-deleted": { + /** @enum {string} */ + action: "deleted"; + installation?: components["schemas"]["simple-installation"]; + organization: components["schemas"]["organization-simple-webhooks"]; + projects_v2_status_update: components["schemas"]["projects-v2-status-update"]; + sender: components["schemas"]["simple-user"]; + }; + /** Projects v2 Status Update Edited Event */ + "webhook-projects-v2-status-update-edited": { + /** @enum {string} */ + action: "edited"; + changes?: { + body?: { + from?: string | null; + to?: string | null; + }; + status?: { + /** @enum {string|null} */ + from?: + | "INACTIVE" + | "ON_TRACK" + | "AT_RISK" + | "OFF_TRACK" + | "COMPLETE" + | null; + /** @enum {string|null} */ + to?: + | "INACTIVE" + | "ON_TRACK" + | "AT_RISK" + | "OFF_TRACK" + | "COMPLETE" + | null; + }; + start_date?: { + /** Format: date */ + from?: string | null; + /** Format: date */ + to?: string | null; + }; + target_date?: { + /** Format: date */ + from?: string | null; + /** Format: date */ + to?: string | null; + }; + }; + installation?: components["schemas"]["simple-installation"]; + organization: components["schemas"]["organization-simple-webhooks"]; + projects_v2_status_update: components["schemas"]["projects-v2-status-update"]; + sender: components["schemas"]["simple-user"]; }; /** public event */ "webhook-public": { @@ -45881,7 +48128,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request assigned event */ "webhook-pull-request-assigned": { @@ -45980,6 +48227,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -46016,6 +48264,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -46076,6 +48325,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -46203,7 +48453,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -46296,6 +48549,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -46359,7 +48613,7 @@ export interface components { /** Format: uri */ url: string; /** - * @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. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -46388,6 +48642,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -46407,6 +48662,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -46546,7 +48802,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -46639,6 +48898,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -46702,7 +48962,7 @@ export interface components { /** Format: uri */ url: string; /** - * @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. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -46731,6 +48991,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -46750,6 +49011,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -46817,6 +49079,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Milestone @@ -46864,6 +49127,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -46932,6 +49196,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null, { deleted?: boolean; @@ -47072,6 +49337,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -47091,10 +49357,11 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request auto_merge_disabled event */ "webhook-pull-request-auto-merge-disabled": { @@ -47192,6 +49459,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -47288,6 +49556,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -47415,7 +49684,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -47508,6 +49780,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -47571,7 +49844,7 @@ export interface components { /** Format: uri */ url: string; /** - * @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. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -47600,6 +49873,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -47619,6 +49893,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -47758,7 +50033,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -47851,6 +50129,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -47914,7 +50193,7 @@ export interface components { /** Format: uri */ url: string; /** - * @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. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -47943,6 +50222,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -47962,6 +50242,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -48029,6 +50310,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Milestone @@ -48076,6 +50358,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -48144,6 +50427,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null, { deleted?: boolean; @@ -48284,6 +50568,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -48303,11 +50588,12 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; reason: string; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request auto_merge_enabled event */ "webhook-pull-request-auto-merge-enabled": { @@ -48405,6 +50691,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -48501,6 +50788,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -48628,7 +50916,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -48721,6 +51012,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -48784,7 +51076,7 @@ export interface components { /** Format: uri */ url: string; /** - * @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. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -48813,6 +51105,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -48832,6 +51125,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -49064,6 +51358,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -49127,7 +51422,7 @@ export interface components { /** Format: uri */ url: string; /** - * @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. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -49156,6 +51451,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -49175,6 +51471,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -49242,6 +51539,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Milestone @@ -49289,6 +51587,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -49357,6 +51656,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null, { deleted?: boolean; @@ -49497,6 +51797,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -49516,11 +51817,12 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; reason?: string; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request closed event */ "webhook-pull-request-closed": { @@ -49532,7 +51834,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; pull_request: components["schemas"]["pull-request-webhook"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request converted_to_draft event */ "webhook-pull-request-converted-to-draft": { @@ -49544,7 +51846,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; pull_request: components["schemas"]["pull-request-webhook"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request demilestoned event */ "webhook-pull-request-demilestoned": { @@ -49556,7 +51858,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; pull_request: components["schemas"]["webhooks_pull_request_5"]; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** pull_request dequeued event */ "webhook-pull-request-dequeued": { @@ -49654,6 +51956,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -49750,6 +52053,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -49877,7 +52181,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -49970,6 +52277,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -50033,7 +52341,7 @@ export interface components { /** Format: uri */ url: string; /** - * @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. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -50062,6 +52370,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -50081,6 +52390,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -50220,7 +52530,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -50313,6 +52626,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -50376,7 +52690,7 @@ export interface components { /** Format: uri */ url: string; /** - * @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. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -50405,6 +52719,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -50424,6 +52739,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -50491,6 +52807,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Milestone @@ -50538,6 +52855,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -50606,6 +52924,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null, { deleted?: boolean; @@ -50746,6 +53065,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -50765,11 +53085,25 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; - reason: string; + /** @enum {string} */ + reason: + | "UNKNOWN_REMOVAL_REASON" + | "MANUAL" + | "MERGE" + | "MERGE_CONFLICT" + | "CI_FAILURE" + | "CI_TIMEOUT" + | "ALREADY_MERGED" + | "QUEUE_CLEARED" + | "ROLL_BACK" + | "BRANCH_PROTECTIONS" + | "GIT_TREE_INVALID" + | "INVALID_MERGE_COMMIT"; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request edited event */ "webhook-pull-request-edited": { @@ -50800,7 +53134,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; pull_request: components["schemas"]["pull-request-webhook"]; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** pull_request enqueued event */ "webhook-pull-request-enqueued": { @@ -50898,6 +53232,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -50994,6 +53329,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -51121,7 +53457,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -51214,6 +53553,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -51277,7 +53617,7 @@ export interface components { /** Format: uri */ url: string; /** - * @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. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -51306,6 +53646,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -51325,6 +53666,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -51464,7 +53806,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -51557,6 +53902,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -51620,7 +53966,7 @@ export interface components { /** Format: uri */ url: string; /** - * @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. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -51649,6 +53995,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -51668,6 +54015,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -51735,6 +54083,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Milestone @@ -51782,6 +54131,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -51850,6 +54200,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null, { deleted?: boolean; @@ -51990,6 +54341,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -52009,10 +54361,11 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request labeled event */ "webhook-pull-request-labeled": { @@ -52111,6 +54464,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -52207,6 +54561,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -52334,7 +54689,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -52427,6 +54785,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -52490,7 +54849,7 @@ export interface components { /** Format: uri */ url: string; /** - * @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. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -52519,6 +54878,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -52538,6 +54898,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -52677,7 +55038,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -52770,6 +55134,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -52833,7 +55198,7 @@ export interface components { /** Format: uri */ url: string; /** - * @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. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -52862,6 +55227,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -52881,6 +55247,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -52948,6 +55315,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Milestone @@ -52995,6 +55363,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -53063,6 +55432,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null, { deleted?: boolean; @@ -53203,6 +55573,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -53222,10 +55593,11 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request locked event */ "webhook-pull-request-locked": { @@ -53323,6 +55695,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -53419,6 +55792,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -53546,7 +55920,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -53639,6 +56016,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -53702,7 +56080,7 @@ export interface components { /** Format: uri */ url: string; /** - * @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. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -53731,6 +56109,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -53750,6 +56129,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -53889,7 +56269,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -53982,6 +56365,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -54045,7 +56429,7 @@ export interface components { /** Format: uri */ url: string; /** - * @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. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -54074,6 +56458,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -54093,6 +56478,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -54160,6 +56546,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Milestone @@ -54207,6 +56594,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -54275,6 +56663,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null, { deleted?: boolean; @@ -54415,6 +56804,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -54434,10 +56824,11 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request milestoned event */ "webhook-pull-request-milestoned": { @@ -54449,7 +56840,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; pull_request: components["schemas"]["webhooks_pull_request_5"]; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** pull_request opened event */ "webhook-pull-request-opened": { @@ -54461,7 +56852,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; pull_request: components["schemas"]["pull-request-webhook"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request ready_for_review event */ "webhook-pull-request-ready-for-review": { @@ -54473,7 +56864,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; pull_request: components["schemas"]["pull-request-webhook"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request reopened event */ "webhook-pull-request-reopened": { @@ -54485,7 +56876,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; pull_request: components["schemas"]["pull-request-webhook"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request_review_comment created event */ "webhook-pull-request-review-comment-created": { @@ -54623,6 +57014,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -54642,6 +57034,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; enterprise?: components["schemas"]["enterprise-webhooks"]; @@ -54733,6 +57126,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -54829,6 +57223,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -54956,7 +57351,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -55049,6 +57447,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -55112,7 +57511,7 @@ export interface components { /** Format: uri */ url: string; /** - * @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. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -55141,6 +57540,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -55160,6 +57560,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -55292,7 +57693,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -55385,6 +57789,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -55448,7 +57853,7 @@ export interface components { /** Format: uri */ url: string; /** - * @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. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -55477,6 +57882,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -55496,6 +57902,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -55567,6 +57974,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -55633,6 +58041,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null, { deleted?: boolean; @@ -55767,6 +58176,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -55786,10 +58196,11 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request_review_comment deleted event */ "webhook-pull-request-review-comment-deleted": { @@ -55885,6 +58296,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -55981,6 +58393,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -56108,7 +58521,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -56201,6 +58617,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -56264,7 +58681,7 @@ export interface components { /** Format: uri */ url: string; /** - * @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. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -56293,6 +58710,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -56312,6 +58730,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -56444,7 +58863,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -56537,6 +58959,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -56600,7 +59023,7 @@ export interface components { /** Format: uri */ url: string; /** - * @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. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -56629,6 +59052,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -56648,6 +59072,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -56719,6 +59144,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -56785,6 +59211,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null, { deleted?: boolean; @@ -56919,6 +59346,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -56938,10 +59366,11 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request_review_comment edited event */ "webhook-pull-request-review-comment-edited": { @@ -57038,6 +59467,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -57074,6 +59504,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -57134,6 +59565,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -57261,7 +59693,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -57354,6 +59789,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -57417,7 +59853,7 @@ export interface components { /** Format: uri */ url: string; /** - * @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. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -57446,6 +59882,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -57465,6 +59902,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -57597,7 +60035,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -57690,6 +60131,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -57753,7 +60195,7 @@ export interface components { /** Format: uri */ url: string; /** - * @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. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -57782,6 +60224,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -57801,6 +60244,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -57872,6 +60316,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -57938,6 +60383,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null, { deleted?: boolean; @@ -58072,6 +60518,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -58089,12 +60536,13 @@ export interface components { subscriptions_url?: string; /** @enum {string} */ type?: "Bot" | "User" | "Organization" | "Mannequin"; + user_view_type?: string; /** Format: uri */ url?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request_review dismissed event */ "webhook-pull-request-review-dismissed": { @@ -58190,6 +60638,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -58286,6 +60735,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -58413,7 +60863,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -58506,6 +60959,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -58569,7 +61023,7 @@ export interface components { /** Format: uri */ url: string; /** - * @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. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -58598,6 +61052,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -58617,6 +61072,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -58749,7 +61205,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -58842,6 +61301,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -58905,7 +61365,7 @@ export interface components { /** Format: uri */ url: string; /** - * @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. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -58934,6 +61394,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -58953,6 +61414,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -59024,6 +61486,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -59090,6 +61553,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null, { deleted?: boolean; @@ -59224,6 +61688,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -59243,6 +61708,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; @@ -59306,6 +61772,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -59325,9 +61792,10 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request_review edited event */ "webhook-pull-request-review-edited": { @@ -59429,6 +61897,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -59525,6 +61994,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -59647,7 +62117,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -59723,6 +62196,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -59788,6 +62262,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -59807,6 +62282,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -59934,7 +62410,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -60010,6 +62489,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -60075,6 +62555,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -60094,6 +62575,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -60165,6 +62647,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -60231,6 +62714,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null, { deleted?: boolean; @@ -60365,6 +62849,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -60384,11 +62869,12 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; review: components["schemas"]["webhooks_review"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request review_request_removed event */ "webhook-pull-request-review-request-removed": OneOf< @@ -60489,6 +62975,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -60525,6 +63012,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -60585,6 +63073,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -60712,7 +63201,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -60805,6 +63297,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -60861,7 +63354,7 @@ export interface components { /** Format: uri */ url: string; /** - * @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. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -60890,6 +63383,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -60909,6 +63403,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -61048,7 +63543,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -61141,6 +63639,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -61204,7 +63703,7 @@ export interface components { /** Format: uri */ url: string; /** - * @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. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -61233,6 +63732,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -61252,6 +63752,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -61319,6 +63820,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Milestone @@ -61366,6 +63868,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -61434,6 +63937,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null, { deleted?: boolean; @@ -61574,6 +64078,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -61593,6 +64098,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; @@ -61632,8 +64138,9 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }, { /** @enum {string} */ @@ -61731,6 +64238,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -61767,6 +64275,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -61827,6 +64336,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -61954,7 +64464,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -62047,6 +64560,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -62110,7 +64624,7 @@ export interface components { /** Format: uri */ url: string; /** - * @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. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -62139,6 +64653,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -62158,6 +64673,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -62297,7 +64813,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -62390,6 +64909,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -62453,7 +64973,7 @@ export interface components { /** Format: uri */ url: string; /** - * @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. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -62482,6 +65002,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -62501,6 +65022,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -62568,6 +65090,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Milestone @@ -62615,6 +65138,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -62683,6 +65207,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null, { deleted?: boolean; @@ -62823,6 +65348,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -62842,6 +65368,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; @@ -62900,7 +65427,7 @@ export interface components { */ url: string; }; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }, ] >; @@ -63003,6 +65530,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -63039,6 +65567,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -63099,6 +65628,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -63226,7 +65756,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -63319,6 +65852,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -63382,7 +65916,7 @@ export interface components { /** Format: uri */ url: string; /** - * @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. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -63411,6 +65945,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -63430,6 +65965,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -63569,7 +66105,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -63662,6 +66201,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -63725,7 +66265,7 @@ export interface components { /** Format: uri */ url: string; /** - * @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. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -63754,6 +66294,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -63773,6 +66314,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -63840,6 +66382,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Milestone @@ -63887,6 +66430,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -63955,6 +66499,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null, { deleted?: boolean; @@ -64095,6 +66640,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -64114,6 +66660,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; @@ -64153,8 +66700,9 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }, { /** @enum {string} */ @@ -64252,6 +66800,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -64288,6 +66837,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -64348,6 +66898,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -64475,7 +67026,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -64568,6 +67122,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -64631,7 +67186,7 @@ export interface components { /** Format: uri */ url: string; /** - * @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. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -64660,6 +67215,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -64679,6 +67235,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -64818,7 +67375,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -64911,6 +67471,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -64974,7 +67535,7 @@ export interface components { /** Format: uri */ url: string; /** - * @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. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -65003,6 +67564,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -65022,6 +67584,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -65089,6 +67652,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Milestone @@ -65136,6 +67700,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -65204,6 +67769,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null, { deleted?: boolean; @@ -65344,6 +67910,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -65363,6 +67930,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; @@ -65421,7 +67989,7 @@ export interface components { */ url?: string; }; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }, ] >; @@ -65519,6 +68087,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -65615,6 +68184,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -65742,7 +68312,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -65835,6 +68408,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -65898,7 +68472,7 @@ export interface components { /** Format: uri */ url: string; /** - * @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. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -65927,6 +68501,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -65946,6 +68521,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -66078,7 +68654,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -66171,6 +68750,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -66234,7 +68814,7 @@ export interface components { /** Format: uri */ url: string; /** - * @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. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -66263,6 +68843,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -66282,6 +68863,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -66353,6 +68935,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -66419,6 +69002,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null, { deleted?: boolean; @@ -66553,6 +69137,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -66572,11 +69157,12 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; review: components["schemas"]["webhooks_review"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request_review_thread resolved event */ "webhook-pull-request-review-thread-resolved": { @@ -66672,6 +69258,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -66768,6 +69355,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -66895,7 +69483,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -66971,6 +69562,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -67038,6 +69630,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -67057,6 +69650,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -67189,7 +69783,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -67265,6 +69862,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -67332,6 +69930,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -67351,6 +69950,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -67422,6 +70022,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -67488,6 +70089,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null, { deleted?: boolean; @@ -67622,6 +70224,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -67641,10 +70244,11 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; thread: { comments: { _links: { @@ -67774,6 +70378,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -67793,6 +70398,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }[]; node_id: string; @@ -67892,6 +70498,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -67988,6 +70595,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -68115,7 +70723,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -68191,6 +70802,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -68258,6 +70870,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -68277,6 +70890,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -68409,7 +71023,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -68485,6 +71102,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -68552,6 +71170,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -68571,6 +71190,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -68642,6 +71262,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -68708,6 +71329,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null, { deleted?: boolean; @@ -68842,6 +71464,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -68861,10 +71484,11 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; thread: { comments: { _links: { @@ -68994,6 +71618,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -69013,6 +71638,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }[]; node_id: string; @@ -69116,6 +71742,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -69212,6 +71839,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -69339,7 +71967,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -69432,6 +72063,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -69495,7 +72127,7 @@ export interface components { /** Format: uri */ url: string; /** - * @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. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -69524,6 +72156,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -69543,6 +72176,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -69682,7 +72316,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -69768,6 +72405,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -69831,7 +72469,7 @@ export interface components { /** Format: uri */ url: string; /** - * @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. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -69860,6 +72498,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -69879,6 +72518,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -69946,6 +72586,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Milestone @@ -69993,6 +72634,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -70061,6 +72703,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null, { deleted?: boolean; @@ -70201,6 +72844,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -70220,10 +72864,11 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request unassigned event */ "webhook-pull-request-unassigned": { @@ -70322,6 +72967,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -70418,6 +73064,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -70545,7 +73192,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -70638,6 +73288,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -70701,7 +73352,7 @@ export interface components { /** Format: uri */ url: string; /** - * @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. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -70730,6 +73381,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -70749,6 +73401,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -70888,7 +73541,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -70981,6 +73637,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -71044,7 +73701,7 @@ export interface components { /** Format: uri */ url: string; /** - * @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. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -71073,6 +73730,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -71092,6 +73750,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -71159,6 +73818,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Milestone @@ -71206,6 +73866,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -71274,6 +73935,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null, { deleted?: boolean; @@ -71414,6 +74076,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -71433,10 +74096,11 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** pull_request unlabeled event */ "webhook-pull-request-unlabeled": { @@ -71535,6 +74199,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -71631,6 +74296,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -71758,7 +74424,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -71851,6 +74520,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -71914,7 +74584,7 @@ export interface components { /** Format: uri */ url: string; /** - * @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. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -71943,6 +74613,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -71962,6 +74633,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -72101,7 +74773,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -72187,6 +74862,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -72250,7 +74926,7 @@ export interface components { /** Format: uri */ url: string; /** - * @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. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -72279,6 +74955,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -72298,6 +74975,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -72365,6 +75043,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Milestone @@ -72412,6 +75091,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -72480,6 +75160,7 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null, { deleted?: boolean; @@ -72620,6 +75301,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -72639,10 +75321,11 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request unlocked event */ "webhook-pull-request-unlocked": { @@ -72740,6 +75423,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -72836,6 +75520,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. @@ -72963,7 +75648,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -73056,6 +75744,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -73119,7 +75808,7 @@ export interface components { /** Format: uri */ url: string; /** - * @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. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -73148,6 +75837,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -73167,6 +75857,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; body: string | null; @@ -73306,7 +75997,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -73399,6 +76093,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -73462,7 +76157,7 @@ export interface components { /** Format: uri */ url: string; /** - * @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. + * @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -73491,6 +76186,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -73510,6 +76206,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ @@ -73577,6 +76274,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** * Milestone @@ -73624,6 +76322,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; description: string | null; /** Format: date-time */ @@ -73692,6 +76391,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null, { deleted?: boolean; @@ -73832,6 +76532,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -73851,10 +76552,11 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** push event */ "webhook-push": { @@ -74112,7 +76814,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -74188,6 +76893,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -74237,7 +76943,7 @@ export interface components { /** @description Whether to require contributors to sign off on web-based commits */ web_commit_signoff_required?: boolean; }; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; "webhook-registry-package-published": { /** @enum {string} */ @@ -74272,6 +76978,7 @@ export interface components { subscriptions_url: string; type: string; url: string; + user_view_type?: string; }; package_type: string; package_version: { @@ -74294,6 +77001,7 @@ export interface components { subscriptions_url: string; type: string; url: string; + user_view_type?: string; }; body?: string | Record; body_html?: string; @@ -74412,6 +77120,7 @@ export interface components { subscriptions_url?: string; type?: string; url?: string; + user_view_type?: string; }; created_at?: string; draft?: boolean; @@ -74442,7 +77151,7 @@ export interface components { updated_at: string | null; }; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; "webhook-registry-package-updated": { /** @enum {string} */ @@ -74477,6 +77186,7 @@ export interface components { subscriptions_url: string; type: string; url: string; + user_view_type?: string; }; package_type: string; package_version: { @@ -74499,6 +77209,7 @@ export interface components { subscriptions_url: string; type: string; url: string; + user_view_type?: string; }; body: string; body_html: string; @@ -74551,6 +77262,7 @@ export interface components { subscriptions_url: string; type: string; url: string; + user_view_type?: string; }; created_at: string; draft: boolean; @@ -74575,7 +77287,7 @@ export interface components { updated_at: string; }; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** release created event */ "webhook-release-created": { @@ -74586,7 +77298,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; release: components["schemas"]["webhooks_release"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** release deleted event */ "webhook-release-deleted": { @@ -74597,7 +77309,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; release: components["schemas"]["webhooks_release"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** release edited event */ "webhook-release-edited": { @@ -74622,7 +77334,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; release: components["schemas"]["webhooks_release"]; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** release prereleased event */ "webhook-release-prereleased": { @@ -74734,6 +77446,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; body: string | null; /** Format: date-time */ @@ -74782,7 +77495,7 @@ export interface components { zipball_url: string | null; }; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** release published event */ "webhook-release-published": { @@ -74793,7 +77506,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; release: components["schemas"]["webhooks_release_1"]; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** release released event */ "webhook-release-released": { @@ -74804,7 +77517,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; release: components["schemas"]["webhooks_release"]; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** release unpublished event */ "webhook-release-unpublished": { @@ -74815,7 +77528,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; release: components["schemas"]["webhooks_release_1"]; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** Repository advisory published event */ "webhook-repository-advisory-published": { @@ -74826,7 +77539,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; repository_advisory: components["schemas"]["repository-advisory"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** Repository advisory reported event */ "webhook-repository-advisory-reported": { @@ -74837,7 +77550,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; repository_advisory: components["schemas"]["repository-advisory"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** repository archived event */ "webhook-repository-archived": { @@ -74847,7 +77560,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** repository created event */ "webhook-repository-created": { @@ -74857,7 +77570,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** repository deleted event */ "webhook-repository-deleted": { @@ -74867,7 +77580,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** repository_dispatch event */ "webhook-repository-dispatch-sample": { @@ -74882,7 +77595,7 @@ export interface components { installation: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** repository edited event */ "webhook-repository-edited": { @@ -74906,7 +77619,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** repository_import event */ "webhook-repository-import": { @@ -74914,7 +77627,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; /** @enum {string} */ status: "success" | "cancelled" | "failure"; }; @@ -74926,7 +77639,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** repository publicized event */ "webhook-repository-publicized": { @@ -74936,7 +77649,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** repository renamed event */ "webhook-repository-renamed": { @@ -74953,7 +77666,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** repository ruleset created event */ "webhook-repository-ruleset-created": { @@ -74964,7 +77677,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; repository_ruleset: components["schemas"]["repository-ruleset"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** repository ruleset deleted event */ "webhook-repository-ruleset-deleted": { @@ -74975,7 +77688,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; repository_ruleset: components["schemas"]["repository-ruleset"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** repository ruleset edited event */ "webhook-repository-ruleset-edited": { @@ -75033,7 +77746,7 @@ export interface components { }[]; }; }; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** repository transferred event */ "webhook-repository-transferred": { @@ -75084,6 +77797,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -75103,6 +77817,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; }; }; @@ -75111,7 +77826,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** repository unarchived event */ "webhook-repository-unarchived": { @@ -75121,7 +77836,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** repository_vulnerability_alert create event */ "webhook-repository-vulnerability-alert-create": { @@ -75132,7 +77847,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** repository_vulnerability_alert dismiss event */ "webhook-repository-vulnerability-alert-dismiss": { @@ -75185,6 +77900,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; external_identifier: string; /** Format: uri */ @@ -75205,7 +77921,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** repository_vulnerability_alert reopen event */ "webhook-repository-vulnerability-alert-reopen": { @@ -75216,7 +77932,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** repository_vulnerability_alert resolve event */ "webhook-repository-vulnerability-alert-resolve": { @@ -75288,7 +78004,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** secret_scanning_alert created event */ "webhook-secret-scanning-alert-created": { @@ -75299,7 +78015,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** Secret Scanning Alert Location Created Event */ "webhook-secret-scanning-alert-location-created": { @@ -75310,13 +78026,24 @@ export interface components { location: components["schemas"]["secret-scanning-location"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Secret Scanning Alert Location Created Event */ "webhook-secret-scanning-alert-location-created-form-encoded": { /** @description A URL-encoded string of the secret_scanning_alert_location.created JSON payload. The decoded payload is a JSON object. */ payload: string; }; + /** secret_scanning_alert publicly leaked event */ + "webhook-secret-scanning-alert-publicly-leaked": { + /** @enum {string} */ + action: "publicly_leaked"; + alert: components["schemas"]["secret-scanning-alert-webhook"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender?: components["schemas"]["simple-user"]; + }; /** secret_scanning_alert reopened event */ "webhook-secret-scanning-alert-reopened": { /** @enum {string} */ @@ -75326,7 +78053,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** secret_scanning_alert resolved event */ "webhook-secret-scanning-alert-resolved": { @@ -75337,29 +78064,61 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; - /** secret_scanning_alert revoked event */ - "webhook-secret-scanning-alert-revoked": { + /** secret_scanning_alert validated event */ + "webhook-secret-scanning-alert-validated": { /** @enum {string} */ - action: "revoked"; + action: "validated"; alert: components["schemas"]["secret-scanning-alert-webhook"]; enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; - /** secret_scanning_alert validated event */ - "webhook-secret-scanning-alert-validated": { + /** secret_scanning_scan completed event */ + "webhook-secret-scanning-scan-completed": { /** @enum {string} */ - action: "validated"; - alert: components["schemas"]["secret-scanning-alert-webhook"]; + action: "completed"; + /** + * @description What type of scan was completed + * @enum {string} + */ + type: "backfill" | "custom-pattern-backfill" | "pattern-version-backfill"; + /** + * @description What type of content was scanned + * @enum {string} + */ + source: "git" | "issues" | "pull-requests" | "discussions" | "wiki"; + /** + * Format: date-time + * @description The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + started_at: string; + /** + * Format: date-time + * @description The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + completed_at: string; + /** @description List of patterns that were updated. This will be empty for normal backfill scans or custom pattern updates */ + secret_types?: string[] | null; + /** @description If the scan was triggered by a custom pattern update, this will be the name of the pattern that was updated */ + custom_pattern_name?: string | null; + /** + * @description If the scan was triggered by a custom pattern update, this will be the scope of the pattern that was updated + * @enum {string|null} + */ + custom_pattern_scope?: + | "repository" + | "organization" + | "enterprise" + | null; + repository?: components["schemas"]["repository-webhooks"]; enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; - repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** security_advisory published event */ "webhook-security-advisory-published": { @@ -75370,7 +78129,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; security_advisory: components["schemas"]["webhooks_security_advisory"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** security_advisory updated event */ "webhook-security-advisory-updated": { @@ -75381,7 +78140,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; security_advisory: components["schemas"]["webhooks_security_advisory"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** security_advisory withdrawn event */ "webhook-security-advisory-withdrawn": { @@ -75397,6 +78156,7 @@ export interface components { score: number; vector_string: string | null; }; + cvss_severities?: components["schemas"]["cvss-severities"]; cwes: { cwe_id: string; name: string; @@ -75428,7 +78188,7 @@ export interface components { }[]; withdrawn_at: string; }; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** security_and_analysis event */ "webhook-security-and-analysis": { @@ -75441,7 +78201,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["full-repository"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** sponsorship cancelled event */ "webhook-sponsorship-cancelled": { @@ -75451,7 +78211,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; sponsorship: components["schemas"]["webhooks_sponsorship"]; }; /** sponsorship created event */ @@ -75462,7 +78222,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; sponsorship: components["schemas"]["webhooks_sponsorship"]; }; /** sponsorship edited event */ @@ -75479,7 +78239,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; sponsorship: components["schemas"]["webhooks_sponsorship"]; }; /** sponsorship pending_cancellation event */ @@ -75491,7 +78251,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; sponsorship: components["schemas"]["webhooks_sponsorship"]; }; /** sponsorship pending_tier_change event */ @@ -75504,7 +78264,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; sponsorship: components["schemas"]["webhooks_sponsorship"]; }; /** sponsorship tier_changed event */ @@ -75516,7 +78276,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; sponsorship: components["schemas"]["webhooks_sponsorship"]; }; /** star created event */ @@ -75527,7 +78287,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; /** @description The time the star was created. This is a timestamp in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. Will be `null` for the `deleted` action. */ starred_at: string | null; }; @@ -75539,7 +78299,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; /** @description The time the star was created. This is a timestamp in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. Will be `null` for the `deleted` action. */ starred_at: unknown; }; @@ -75654,6 +78414,7 @@ export interface components { | "ocsp_pending"; signature: string | null; verified: boolean; + verified_at?: string | null; }; }; /** User */ @@ -75718,7 +78479,7 @@ export interface components { name: string; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; /** @description The Commit SHA. */ sha: string; /** @@ -75730,13 +78491,77 @@ export interface components { target_url: string | null; updated_at: string; }; + /** parent issue added event */ + "webhook-sub-issues-parent-issue-added": { + /** @enum {string} */ + action: "parent_issue_added"; + /** @description The ID of the parent issue. */ + parent_issue_id: number; + parent_issue: components["schemas"]["issue"]; + parent_issue_repo: components["schemas"]["repository"]; + /** @description The ID of the sub-issue. */ + sub_issue_id: number; + sub_issue: components["schemas"]["issue"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository?: components["schemas"]["repository-webhooks"]; + sender?: components["schemas"]["simple-user"]; + }; + /** parent issue removed event */ + "webhook-sub-issues-parent-issue-removed": { + /** @enum {string} */ + action: "parent_issue_removed"; + /** @description The ID of the parent issue. */ + parent_issue_id: number; + parent_issue: components["schemas"]["issue"]; + parent_issue_repo: components["schemas"]["repository"]; + /** @description The ID of the sub-issue. */ + sub_issue_id: number; + sub_issue: components["schemas"]["issue"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository?: components["schemas"]["repository-webhooks"]; + sender?: components["schemas"]["simple-user"]; + }; + /** sub-issue added event */ + "webhook-sub-issues-sub-issue-added": { + /** @enum {string} */ + action: "sub_issue_added"; + /** @description The ID of the sub-issue. */ + sub_issue_id: number; + sub_issue: components["schemas"]["issue"]; + sub_issue_repo: components["schemas"]["repository"]; + /** @description The ID of the parent issue. */ + parent_issue_id: number; + parent_issue: components["schemas"]["issue"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository?: components["schemas"]["repository-webhooks"]; + sender?: components["schemas"]["simple-user"]; + }; + /** sub-issue removed event */ + "webhook-sub-issues-sub-issue-removed": { + /** @enum {string} */ + action: "sub_issue_removed"; + /** @description The ID of the sub-issue. */ + sub_issue_id: number; + sub_issue: components["schemas"]["issue"]; + sub_issue_repo: components["schemas"]["repository"]; + /** @description The ID of the parent issue. */ + parent_issue_id: number; + parent_issue: components["schemas"]["issue"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository?: components["schemas"]["repository-webhooks"]; + sender?: components["schemas"]["simple-user"]; + }; /** team_add event */ "webhook-team-add": { enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; team: components["schemas"]["webhooks_team_1"]; }; /** team added_to_repository event */ @@ -75862,256 +78687,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ - id: number; - is_template?: boolean; - /** Format: uri-template */ - issue_comment_url: string; - /** Format: uri-template */ - issue_events_url: string; - /** Format: uri-template */ - issues_url: string; - /** Format: uri-template */ - keys_url: string; - /** Format: uri-template */ - labels_url: string; - language: string | null; - /** Format: uri */ - languages_url: string; - /** License */ - license: { - key: string; - name: string; - node_id: string; - spdx_id: string; - /** Format: uri */ - url: string | null; - } | null; - master_branch?: string; - /** Format: uri */ - merges_url: string; - /** Format: uri-template */ - milestones_url: string; - /** Format: uri */ - mirror_url: string | null; - /** @description The name of the repository. */ - name: string; - node_id: string; - /** Format: uri-template */ - notifications_url: string; - open_issues: number; - open_issues_count: number; - organization?: string; - /** User */ - owner: { - /** Format: uri */ - avatar_url?: string; - deleted?: boolean; - email?: string | null; - /** Format: uri-template */ - events_url?: string; - /** Format: uri */ - followers_url?: string; - /** Format: uri-template */ - following_url?: string; - /** Format: uri-template */ - gists_url?: string; - gravatar_id?: string; - /** Format: uri */ - html_url?: string; - id: number; - login: string; - name?: string; - node_id?: string; - /** Format: uri */ - organizations_url?: string; - /** Format: uri */ - received_events_url?: string; - /** Format: uri */ - repos_url?: string; - site_admin?: boolean; - /** Format: uri-template */ - starred_url?: string; - /** Format: uri */ - subscriptions_url?: string; - /** @enum {string} */ - type?: "Bot" | "User" | "Organization"; - /** Format: uri */ - url?: string; - } | null; - permissions?: { - admin: boolean; - maintain?: boolean; - pull: boolean; - push: boolean; - triage?: boolean; - }; - /** @description Whether the repository is private or public. */ - private: boolean; - public?: boolean; - /** Format: uri-template */ - pulls_url: string; - pushed_at: number | string | null; - /** Format: uri-template */ - releases_url: string; - role_name?: string | null; - size: number; - ssh_url: string; - stargazers?: number; - stargazers_count: number; - /** Format: uri */ - stargazers_url: string; - /** Format: uri-template */ - statuses_url: string; - /** Format: uri */ - subscribers_url: string; - /** Format: uri */ - subscription_url: string; - /** Format: uri */ - svn_url: string; - /** Format: uri */ - tags_url: string; - /** Format: uri */ - teams_url: string; - topics: string[]; - /** Format: uri-template */ - trees_url: string; - /** Format: date-time */ - updated_at: string; - /** Format: uri */ - url: string; - /** @enum {string} */ - visibility: "public" | "private" | "internal"; - watchers: number; - watchers_count: number; - }; - sender?: components["schemas"]["simple-user-webhooks"]; - team: components["schemas"]["webhooks_team_1"]; - }; - /** team created event */ - "webhook-team-created": { - /** @enum {string} */ - action: "created"; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization: components["schemas"]["organization-simple-webhooks"]; - /** - * Repository - * @description A git repository - */ - repository?: { - /** - * @description Whether to allow auto-merge for pull requests. - * @default false - */ - allow_auto_merge?: boolean; - /** @description Whether to allow private forks */ - allow_forking?: boolean; - /** - * @description Whether to allow merge commits for pull requests. - * @default true - */ - allow_merge_commit?: boolean; /** - * @description Whether to allow rebase merges for pull requests. - * @default true - */ - allow_rebase_merge?: boolean; - /** - * @description Whether to allow squash merges for pull requests. - * @default true - */ - allow_squash_merge?: boolean; - allow_update_branch?: boolean; - /** Format: uri-template */ - archive_url: string; - /** - * @description Whether the repository is archived. - * @default false - */ - archived: boolean; - /** Format: uri-template */ - assignees_url: string; - /** Format: uri-template */ - blobs_url: string; - /** Format: uri-template */ - branches_url: string; - /** Format: uri */ - clone_url: string; - /** Format: uri-template */ - collaborators_url: string; - /** Format: uri-template */ - comments_url: string; - /** Format: uri-template */ - commits_url: string; - /** Format: uri-template */ - compare_url: string; - /** Format: uri-template */ - contents_url: string; - /** Format: uri */ - contributors_url: string; - created_at: number | 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?: { - [key: string]: unknown; - }; - /** @description The default branch of the repository. */ - default_branch: string; - /** - * @description Whether to delete head branches when pull requests are merged - * @default false - */ - delete_branch_on_merge?: boolean; - /** Format: uri */ - deployments_url: string; - description: string | null; - /** @description Returns whether or not this repository is disabled. */ - disabled?: boolean; - /** Format: uri */ - downloads_url: string; - /** Format: uri */ - events_url: string; - fork: boolean; - forks: number; - forks_count: number; - /** Format: uri */ - forks_url: string; - full_name: string; - /** Format: uri-template */ - git_commits_url: string; - /** Format: uri-template */ - git_refs_url: string; - /** Format: uri-template */ - git_tags_url: string; - /** Format: uri */ - git_url: string; - /** - * @description Whether downloads are enabled. - * @default true - */ - has_downloads: boolean; - /** - * @description Whether issues are enabled. - * @default true - */ - has_issues: boolean; - has_pages: boolean; - /** - * @description Whether projects are enabled. - * @default true - */ - has_projects: boolean; - /** - * @description Whether the wiki is enabled. - * @default true + * Format: int64 + * @description Unique identifier of the repository */ - has_wiki: boolean; - homepage: string | null; - /** Format: uri */ - hooks_url: string; - /** Format: uri */ - html_url: string; - /** @description Unique identifier of the repository */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -76187,6 +78766,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -76234,7 +78814,260 @@ export interface components { watchers: number; watchers_count: number; }; - sender: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; + team: components["schemas"]["webhooks_team_1"]; + }; + /** team created event */ + "webhook-team-created": { + /** @enum {string} */ + action: "created"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization: components["schemas"]["organization-simple-webhooks"]; + /** + * Repository + * @description A git repository + */ + repository?: { + /** + * @description Whether to allow auto-merge for pull requests. + * @default false + */ + allow_auto_merge?: boolean; + /** @description Whether to allow private forks */ + allow_forking?: boolean; + /** + * @description Whether to allow merge commits for pull requests. + * @default true + */ + allow_merge_commit?: boolean; + /** + * @description Whether to allow rebase merges for pull requests. + * @default true + */ + allow_rebase_merge?: boolean; + /** + * @description Whether to allow squash merges for pull requests. + * @default true + */ + allow_squash_merge?: boolean; + allow_update_branch?: boolean; + /** Format: uri-template */ + archive_url: string; + /** + * @description Whether the repository is archived. + * @default false + */ + archived: boolean; + /** Format: uri-template */ + assignees_url: string; + /** Format: uri-template */ + blobs_url: string; + /** Format: uri-template */ + branches_url: string; + /** Format: uri */ + clone_url: string; + /** Format: uri-template */ + collaborators_url: string; + /** Format: uri-template */ + comments_url: string; + /** Format: uri-template */ + commits_url: string; + /** Format: uri-template */ + compare_url: string; + /** Format: uri-template */ + contents_url: string; + /** Format: uri */ + contributors_url: string; + created_at: number | 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?: { + [key: string]: unknown; + }; + /** @description The default branch of the repository. */ + default_branch: string; + /** + * @description Whether to delete head branches when pull requests are merged + * @default false + */ + delete_branch_on_merge?: boolean; + /** Format: uri */ + deployments_url: string; + description: string | null; + /** @description Returns whether or not this repository is disabled. */ + disabled?: boolean; + /** Format: uri */ + downloads_url: string; + /** Format: uri */ + events_url: string; + fork: boolean; + forks: number; + forks_count: number; + /** Format: uri */ + forks_url: string; + full_name: string; + /** Format: uri-template */ + git_commits_url: string; + /** Format: uri-template */ + git_refs_url: string; + /** Format: uri-template */ + git_tags_url: string; + /** Format: uri */ + git_url: string; + /** + * @description Whether downloads are enabled. + * @default true + */ + has_downloads: boolean; + /** + * @description Whether issues are enabled. + * @default true + */ + has_issues: boolean; + has_pages: boolean; + /** + * @description Whether projects are enabled. + * @default true + */ + has_projects: boolean; + /** + * @description Whether the wiki is enabled. + * @default true + */ + has_wiki: boolean; + homepage: string | null; + /** Format: uri */ + hooks_url: string; + /** Format: uri */ + html_url: string; + /** + * Format: int64 + * @description Unique identifier of the repository + */ + id: number; + is_template?: boolean; + /** Format: uri-template */ + issue_comment_url: string; + /** Format: uri-template */ + issue_events_url: string; + /** Format: uri-template */ + issues_url: string; + /** Format: uri-template */ + keys_url: string; + /** Format: uri-template */ + labels_url: string; + language: string | null; + /** Format: uri */ + languages_url: string; + /** License */ + license: { + key: string; + name: string; + node_id: string; + spdx_id: string; + /** Format: uri */ + url: string | null; + } | null; + master_branch?: string; + /** Format: uri */ + merges_url: string; + /** Format: uri-template */ + milestones_url: string; + /** Format: uri */ + mirror_url: string | null; + /** @description The name of the repository. */ + name: string; + node_id: string; + /** Format: uri-template */ + notifications_url: string; + open_issues: number; + open_issues_count: number; + organization?: string; + /** User */ + owner: { + /** Format: uri */ + avatar_url?: string; + deleted?: boolean; + email?: string | null; + /** Format: uri-template */ + events_url?: string; + /** Format: uri */ + followers_url?: string; + /** Format: uri-template */ + following_url?: string; + /** Format: uri-template */ + gists_url?: string; + gravatar_id?: string; + /** Format: uri */ + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; + /** Format: uri */ + organizations_url?: string; + /** Format: uri */ + received_events_url?: string; + /** Format: uri */ + repos_url?: string; + site_admin?: boolean; + /** Format: uri-template */ + starred_url?: string; + /** Format: uri */ + subscriptions_url?: string; + /** @enum {string} */ + type?: "Bot" | "User" | "Organization"; + /** Format: uri */ + url?: string; + user_view_type?: string; + } | null; + permissions?: { + admin: boolean; + maintain?: boolean; + pull: boolean; + push: boolean; + triage?: boolean; + }; + /** @description Whether the repository is private or public. */ + private: boolean; + public?: boolean; + /** Format: uri-template */ + pulls_url: string; + pushed_at: number | string | null; + /** Format: uri-template */ + releases_url: string; + role_name?: string | null; + size: number; + ssh_url: string; + stargazers?: number; + stargazers_count: number; + /** Format: uri */ + stargazers_url: string; + /** Format: uri-template */ + statuses_url: string; + /** Format: uri */ + subscribers_url: string; + /** Format: uri */ + subscription_url: string; + /** Format: uri */ + svn_url: string; + /** Format: uri */ + tags_url: string; + /** Format: uri */ + teams_url: string; + topics: string[]; + /** Format: uri-template */ + trees_url: string; + /** Format: date-time */ + updated_at: string; + /** Format: uri */ + url: string; + /** @enum {string} */ + visibility: "public" | "private" | "internal"; + watchers: number; + watchers_count: number; + }; + sender: components["schemas"]["simple-user"]; team: components["schemas"]["webhooks_team_1"]; }; /** team deleted event */ @@ -76360,7 +79193,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -76436,6 +79272,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -76483,7 +79320,7 @@ export interface components { watchers: number; watchers_count: number; }; - sender?: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user"]; team: components["schemas"]["webhooks_team_1"]; }; /** team edited event */ @@ -76640,7 +79477,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -76716,6 +79556,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -76763,7 +79604,7 @@ export interface components { watchers: number; watchers_count: number; }; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; team: components["schemas"]["webhooks_team_1"]; }; /** team removed_from_repository event */ @@ -76889,7 +79730,10 @@ export interface components { hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ + /** + * Format: int64 + * @description Unique identifier of the repository + */ id: number; is_template?: boolean; /** Format: uri-template */ @@ -76965,6 +79809,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; permissions?: { admin: boolean; @@ -77012,7 +79857,7 @@ export interface components { watchers: number; watchers_count: number; }; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; team: components["schemas"]["webhooks_team_1"]; }; /** watch started event */ @@ -77023,7 +79868,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** workflow_dispatch event */ "webhook-workflow-dispatch": { @@ -77035,7 +79880,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; ref: string; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; workflow: string; }; /** workflow_job completed event */ @@ -77046,7 +79891,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; workflow_job: { /** Format: uri */ check_run_url: string; @@ -77151,7 +79996,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; workflow_job: { /** Format: uri */ check_run_url: string; @@ -77249,7 +80094,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; workflow_job: { /** Format: uri */ check_run_url: string; @@ -77303,7 +80148,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; workflow_job: { /** Format: uri */ check_run_url: string; @@ -77362,7 +80207,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; workflow: components["schemas"]["webhooks_workflow"]; /** Workflow Run */ workflow_run: { @@ -77402,6 +80247,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** Format: uri */ artifacts_url: string; @@ -77421,6 +80267,7 @@ export interface components { | "stale" | "success" | "timed_out" + | "startup_failure" | null; /** Format: date-time */ created_at: string; @@ -77561,6 +80408,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description Whether the repository is private or public. */ private: boolean; @@ -77735,6 +80583,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description Whether the repository is private or public. */ private: boolean; @@ -77809,6 +80658,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** Format: date-time */ updated_at: string; @@ -77832,7 +80682,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; workflow: components["schemas"]["webhooks_workflow"]; /** Workflow Run */ workflow_run: { @@ -78296,7 +81146,7 @@ export interface components { installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user"]; workflow: components["schemas"]["webhooks_workflow"]; /** Workflow Run */ workflow_run: { @@ -78336,6 +81186,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** Format: uri */ artifacts_url: string; @@ -78496,6 +81347,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description Whether the repository is private or public. */ private: boolean; @@ -78670,6 +81522,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** @description Whether the repository is private or public. */ private: boolean; @@ -78744,6 +81597,7 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; /** Format: date-time */ updated_at: string; @@ -78804,12 +81658,16 @@ export interface components { "application/json": components["schemas"]["basic-error"]; }; }; - /** @description Internal Error */ - internal_error: { + /** @description Conflict */ + conflict: { content: { "application/json": components["schemas"]["basic-error"]; }; }; + /** @description A header with no content is returned. */ + no_content: { + content: never; + }; /** @description Service unavailable */ service_unavailable: { content: { @@ -78840,8 +81698,14 @@ export interface components { "application/json": components["schemas"]["basic-error"]; }; }; - /** @description Conflict */ - conflict: { + /** @description Billing usage report response for an organization */ + billing_usage_report_org: { + content: { + "application/json": components["schemas"]["billing-usage-report"]; + }; + }; + /** @description Internal Error */ + internal_error: { content: { "application/json": components["schemas"]["basic-error"]; }; @@ -78874,14 +81738,16 @@ export interface components { }; }; }; + /** @description Copilot Usage Merics API setting is disabled at the organization or enterprise level. */ + usage_metrics_api_disabled: { + 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; }; - /** @description A header with no content is returned. */ - no_content: { - content: never; - }; /** @description Gone */ gone: { content: { @@ -78906,6 +81772,18 @@ export interface components { "application/json": components["schemas"]["basic-error"]; }; }; + /** @description Bad Request */ + code_scanning_bad_request: { + content: { + "application/json": components["schemas"]["basic-error"]; + }; + }; + /** @description Response if the repository is archived, if GitHub Advanced Security is not enabled for this repository or if rate limit is exceeded */ + code_scanning_autofix_create_forbidden: { + content: { + "application/json": components["schemas"]["basic-error"]; + }; + }; /** @description Found */ found: { content: never; @@ -78964,6 +81842,8 @@ 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 The unique identifier of the code security configuration. */ + "configuration-id": number; /** * @description A comma-separated list of states. If specified, only alerts with these states will be returned. * @@ -79006,11 +81886,7 @@ export interface components { "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. - */ + /** @description A comma-separated list of secret types to return. All default secret patterns are returned. To return experimental patterns, pass the token name(s) in the parameter. See "[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" 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; @@ -79018,6 +81894,10 @@ export interface components { "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; + /** @description A boolean value representing whether or not to filter alerts by the publicly-leaked tag being present. */ + "secret-scanning-alert-publicly-leaked"?: boolean; + /** @description A boolean value representing whether or not to filter alerts by the multi-repo tag being present. */ + "secret-scanning-alert-multi-repo"?: boolean; /** @description The unique identifier of the gist. */ "gist-id": string; /** @description The unique identifier of the comment. */ @@ -79046,8 +81926,20 @@ export interface components { "since-org"?: number; /** @description The organization name. The name is not case sensitive. */ org: string; + /** @description If specified, only return results for a single year. The value of `year` is an integer with four digits representing a year. For example, `2024`. Default value is the current year. */ + "billing-usage-report-year"?: number; + /** @description If specified, only return results for a single month. The value of `month` is an integer between `1` and `12`. */ + "billing-usage-report-month"?: number; + /** @description If specified, only return results for a single day. The value of `day` is an integer between `1` and `31`. */ + "billing-usage-report-day"?: number; + /** @description If specified, only return results for a single hour. The value of `hour` is an integer between `0` and `23`. */ + "billing-usage-report-hour"?: 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; + /** @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 The name of a self-hosted runner's custom label. */ @@ -79066,6 +81958,46 @@ export interface components { "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 type of the actor */ + "api-insights-actor-type": + | "installation" + | "classic_pat" + | "fine_grained_pat" + | "oauth_app" + | "github_app_user_to_server"; + /** @description The ID of the actor */ + "api-insights-actor-id": number; + /** @description The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ + "api-insights-min-timestamp": string; + /** @description The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ + "api-insights-max-timestamp"?: string; + /** @description The property to sort the results by. */ + "api-insights-route-stats-sort"?: ( + | "last_rate_limited_timestamp" + | "last_request_timestamp" + | "rate_limited_request_count" + | "http_method" + | "api_route" + | "total_request_count" + )[]; + /** @description Providing a substring will filter results where the API route contains the substring. This is a case-insensitive search. */ + "api-insights-api-route-substring"?: string; + /** @description The property to sort the results by. */ + "api-insights-sort"?: ( + | "last_rate_limited_timestamp" + | "last_request_timestamp" + | "rate_limited_request_count" + | "subject_name" + | "total_request_count" + )[]; + /** @description Providing a substring will filter results where the subject name contains the substring. This is a case-insensitive search. */ + "api-insights-subject-name-substring"?: string; + /** @description The ID of the user to query for stats */ + "api-insights-user-id": string; + /** @description The increment of time used to breakdown the query results (5m, 10m, 1h, etc.) */ + "api-insights-timestamp-increment": string; + /** @description Providing a substring will filter results where the actor name contains the substring. This is a case-insensitive search. */ + "api-insights-actor-name-substring"?: string; /** @description The unique identifier of the invitation. */ "invitation-id": number; /** @description The name of the codespace. */ @@ -79111,10 +82043,18 @@ export interface components { "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. */ + /** @description The custom property name */ "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 A comma-separated list of rule targets to filter by. + * If provided, only rulesets that apply to the specified targets will be returned. + * For example, `branch,tag,push`. + */ + "ruleset-targets"?: string; + /** @description The name of the ref. Cannot contain wildcard characters. Optionally prefix with `refs/heads/` to limit to branches or `refs/tags/` to limit to tags. Omit the prefix to search across all refs. When specified, only rule evaluations triggered for this ref will be returned. */ + "ref-in-query"?: string; + /** @description The name of the repository to filter on. */ + "repository-name-in-query"?: string; /** * @description The time period to filter by. * @@ -79233,6 +82173,8 @@ export interface components { 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"]; + /** @description The number of the pull request for the results you want to list. */ + "pr-alias"?: number; /** @description The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation. */ "alert-number": components["schemas"]["alert-number"]; /** @description The SHA of the commit. */ @@ -79281,8 +82223,6 @@ export interface components { "asset-id": number; /** @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; /** @description The unique identifier of the tag protection. */ "tag-protection-id": number; /** @description The time frame to display results for. */ @@ -79399,13 +82339,23 @@ export interface operations { * 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 If specified, only return advisories that have an EPSS percentage score that matches the provided value. + * The EPSS percentage represents the likelihood of a CVE being exploited. + */ + epss_percentage?: string; + /** + * @description If specified, only return advisories that have an EPSS percentile score that matches the provided value. + * The EPSS percentile represents the relative rank of the CVE's likelihood of being exploited compared to other CVEs. + */ + epss_percentile?: string; before?: components["parameters"]["pagination-before"]; after?: components["parameters"]["pagination-after"]; 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"; + sort?: "updated" | "published" | "epss_percentage" | "epss_percentile"; }; }; responses: { @@ -79540,7 +82490,6 @@ export interface operations { query?: { per_page?: components["parameters"]["per-page"]; cursor?: components["parameters"]["cursor"]; - redelivery?: boolean; }; }; responses: { @@ -80108,8 +83057,6 @@ export interface operations { * * 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": { @@ -80189,7 +83136,7 @@ export interface operations { }; /** * 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. + * @description OAuth and GitHub application owners can revoke a grant for their application and a specific user. You must 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": { @@ -80216,7 +83163,7 @@ export interface operations { }; /** * 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`. + * @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. Invalid tokens will return `404 NOT FOUND`. */ "apps/check-token": { parameters: { @@ -80245,7 +83192,7 @@ export interface operations { }; /** * 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. + * @description OAuth or GitHub application owners can revoke a single token for an OAuth application or a GitHub application with an OAuth authorization. */ "apps/delete-token": { parameters: { @@ -80271,7 +83218,7 @@ export interface operations { }; /** * 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`. + * @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. Invalid tokens will return `404 NOT FOUND`. */ "apps/reset-token": { parameters: { @@ -80304,10 +83251,6 @@ export interface operations { * 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: { @@ -80361,7 +83304,8 @@ export interface operations { }; /** * 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`). + * @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: { @@ -80560,48 +83504,469 @@ export interface operations { }; }; /** - * Get a summary of Copilot usage for enterprise members - * @description **Note**: This endpoint is in beta and is subject to change. + * Get code security configurations for an enterprise + * @description Lists all code security configurations available in an enterprise. * - * 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 authenticated user must be an administrator of the enterprise in order to use this endpoint. * - * 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. + * OAuth app tokens and personal access tokens (classic) need the `read:enterprise` scope to use this endpoint. + */ + "code-security/get-configurations-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/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + per_page?: number; + before?: components["parameters"]["pagination-before"]; + after?: components["parameters"]["pagination-after"]; + }; + path: { + enterprise: components["parameters"]["enterprise"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["code-security-configuration"][]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + /** + * Create a code security configuration for an enterprise + * @description Creates a code security configuration in an 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. + */ + "code-security/create-configuration-for-enterprise": { + parameters: { + path: { + enterprise: components["parameters"]["enterprise"]; + }; + }; + requestBody: { + content: { + "application/json": { + /** @description The name of the code security configuration. Must be unique within the enterprise. */ + name: string; + /** @description A description of the code security configuration */ + description: string; + /** + * @description The enablement status of GitHub Advanced Security + * @default disabled + * @enum {string} + */ + advanced_security?: "enabled" | "disabled"; + /** + * @description The enablement status of Dependency Graph + * @default enabled + * @enum {string} + */ + dependency_graph?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Automatic dependency submission + * @default disabled + * @enum {string} + */ + dependency_graph_autosubmit_action?: + | "enabled" + | "disabled" + | "not_set"; + /** @description Feature options for Automatic dependency submission */ + dependency_graph_autosubmit_action_options?: { + /** + * @description Whether to use runners labeled with 'dependency-submission' or standard GitHub runners. + * @default false + */ + labeled_runners?: boolean; + }; + /** + * @description The enablement status of Dependabot alerts + * @default disabled + * @enum {string} + */ + dependabot_alerts?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Dependabot security updates + * @default disabled + * @enum {string} + */ + dependabot_security_updates?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of code scanning default setup + * @default disabled + * @enum {string} + */ + code_scanning_default_setup?: "enabled" | "disabled" | "not_set"; + code_scanning_default_setup_options?: components["schemas"]["code-scanning-default-setup-options"]; + /** + * @description The enablement status of secret scanning + * @default disabled + * @enum {string} + */ + secret_scanning?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning push protection + * @default disabled + * @enum {string} + */ + secret_scanning_push_protection?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning validity checks + * @default disabled + * @enum {string} + */ + secret_scanning_validity_checks?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning non provider patterns + * @default disabled + * @enum {string} + */ + secret_scanning_non_provider_patterns?: + | "enabled" + | "disabled" + | "not_set"; + /** + * @description The enablement status of private vulnerability reporting + * @default disabled + * @enum {string} + */ + private_vulnerability_reporting?: "enabled" | "disabled" | "not_set"; + /** + * @description The enforcement status for a security configuration + * @default enforced + * @enum {string} + */ + enforcement?: "enforced" | "unenforced"; + }; + }; + }; + responses: { + /** @description Successfully created code security configuration */ + 201: { + content: { + "application/json": components["schemas"]["code-security-configuration"]; + }; + }; + 400: components["responses"]["bad_request"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + /** + * Get default code security configurations for an enterprise + * @description Lists the default code security configurations for an 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 `read:enterprise` scope to use this endpoint. + */ + "code-security/get-default-configurations-for-enterprise": { + parameters: { + path: { + enterprise: components["parameters"]["enterprise"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["code-security-default-configurations"]; + }; + }; + }; + }; + /** + * Retrieve a code security configuration of an enterprise + * @description Gets a code security configuration available in an 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 `read:enterprise` scope to use this endpoint. + */ + "code-security/get-single-configuration-for-enterprise": { + parameters: { + path: { + enterprise: components["parameters"]["enterprise"]; + configuration_id: components["parameters"]["configuration-id"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["code-security-configuration"]; + }; + }; + 304: components["responses"]["not_modified"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + /** + * Delete a code security configuration for an enterprise + * @description Deletes a code security configuration from an enterprise. + * Repositories attached to the configuration will retain their settings but will no longer be associated with + * the configuration. * - * Only the owners and billing managers of enterprises with a Copilot Business or Enterprise subscription can view Copilot usage - * metrics for the enterprise. + * The authenticated user must be an administrator for the enterprise 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. + * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. */ - "copilot/usage-metrics-for-enterprise": { + "code-security/delete-configuration-for-enterprise": { + parameters: { + path: { + enterprise: components["parameters"]["enterprise"]; + configuration_id: components["parameters"]["configuration-id"]; + }; + }; + responses: { + 204: components["responses"]["no_content"]; + 400: components["responses"]["bad_request"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; + }; + }; + /** + * Update a custom code security configuration for an enterprise + * @description Updates a code security configuration in an 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. + */ + "code-security/update-enterprise-configuration": { + parameters: { + path: { + enterprise: components["parameters"]["enterprise"]; + configuration_id: components["parameters"]["configuration-id"]; + }; + }; + requestBody: { + content: { + "application/json": { + /** @description The name of the code security configuration. Must be unique across the enterprise. */ + name?: string; + /** @description A description of the code security configuration */ + description?: string; + /** + * @description The enablement status of GitHub Advanced Security. Must be set to enabled if you want to enable any GHAS settings. + * @enum {string} + */ + advanced_security?: "enabled" | "disabled"; + /** + * @description The enablement status of Dependency Graph + * @enum {string} + */ + dependency_graph?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Automatic dependency submission + * @enum {string} + */ + dependency_graph_autosubmit_action?: + | "enabled" + | "disabled" + | "not_set"; + /** @description Feature options for Automatic dependency submission */ + dependency_graph_autosubmit_action_options?: { + /** @description Whether to use runners labeled with 'dependency-submission' or standard GitHub runners. */ + labeled_runners?: boolean; + }; + /** + * @description The enablement status of Dependabot alerts + * @enum {string} + */ + dependabot_alerts?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Dependabot security updates + * @enum {string} + */ + dependabot_security_updates?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of code scanning default setup + * @enum {string} + */ + code_scanning_default_setup?: "enabled" | "disabled" | "not_set"; + code_scanning_default_setup_options?: components["schemas"]["code-scanning-default-setup-options"]; + /** + * @description The enablement status of secret scanning + * @enum {string} + */ + secret_scanning?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning push protection + * @enum {string} + */ + secret_scanning_push_protection?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning validity checks + * @enum {string} + */ + secret_scanning_validity_checks?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning non-provider patterns + * @enum {string} + */ + secret_scanning_non_provider_patterns?: + | "enabled" + | "disabled" + | "not_set"; + /** + * @description The enablement status of private vulnerability reporting + * @enum {string} + */ + private_vulnerability_reporting?: "enabled" | "disabled" | "not_set"; + /** + * @description The enforcement status for a security configuration + * @enum {string} + */ + enforcement?: "enforced" | "unenforced"; + }; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["code-security-configuration"]; + }; + }; + 304: components["responses"]["not_modified"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; + }; + }; + /** + * Attach an enterprise configuration to repositories + * @description Attaches an enterprise code security configuration to repositories. If the repositories specified are already attached to a configuration, they will be re-attached to the provided configuration. + * + * If insufficient GHAS licenses are available to attach the configuration to a repository, only free features will be enabled. + * + * The authenticated user must be an administrator for the enterprise to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + */ + "code-security/attach-enterprise-configuration": { + parameters: { + path: { + enterprise: components["parameters"]["enterprise"]; + configuration_id: components["parameters"]["configuration-id"]; + }; + }; + requestBody: { + content: { + "application/json": { + /** + * @description The type of repositories to attach the configuration to. `selected` means the configuration will be attached to only the repositories specified by `selected_repository_ids` + * @enum {string} + */ + scope: "all" | "all_without_configurations"; + }; + }; + }; + responses: { + 202: components["responses"]["accepted"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; + }; + }; + /** + * Set a code security configuration as a default for an enterprise + * @description Sets a code security configuration as a default to be applied to new repositories in your enterprise. + * + * This configuration will be applied by default to the matching repository type when created, but only for organizations within the enterprise that do not already have a default code security configuration set. + * + * The authenticated user must be an administrator for the enterprise to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + */ + "code-security/set-configuration-as-default-for-enterprise": { + parameters: { + path: { + enterprise: components["parameters"]["enterprise"]; + configuration_id: components["parameters"]["configuration-id"]; + }; + }; + requestBody: { + content: { + "application/json": { + /** + * @description Specify which types of repository this security configuration should be applied to by default. + * @enum {string} + */ + default_for_new_repos?: + | "all" + | "none" + | "private_and_internal" + | "public"; + }; + }; + }; + responses: { + /** @description Default successfully changed. */ + 200: { + content: { + "application/json": { + /** + * @description Specifies which types of repository this security configuration is applied to by default. + * @enum {string} + */ + default_for_new_repos?: + | "all" + | "none" + | "private_and_internal" + | "public"; + configuration?: components["schemas"]["code-security-configuration"]; + }; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + /** + * Get repositories associated with an enterprise code security configuration + * @description Lists the repositories associated with an enterprise code security configuration in an organization. + * + * 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 `read:enterprise` scope to use this endpoint. + */ + "code-security/get-repositories-for-enterprise-configuration": { parameters: { query?: { - /** @description Show usage metrics since this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). Maximum value is 28 days ago. */ - 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; - 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)." */ + /** @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; + before?: components["parameters"]["pagination-before"]; + after?: components["parameters"]["pagination-after"]; + /** + * @description A comma-separated list of statuses. If specified, only repositories with these attachment statuses will be returned. + * + * Can be: `all`, `attached`, `attaching`, `removed`, `enforced`, `failed`, `updating`, `removed_by_enterprise` + */ + status?: string; }; path: { enterprise: components["parameters"]["enterprise"]; + configuration_id: components["parameters"]["configuration-id"]; }; }; responses: { /** @description Response */ 200: { content: { - "application/json": components["schemas"]["copilot-usage-metrics"][]; + "application/json": components["schemas"]["code-security-configuration-repositories"][]; }; }; - 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; - 500: components["responses"]["internal_error"]; }; }; /** @@ -80669,6 +84034,8 @@ export interface operations { before?: components["parameters"]["pagination-before"]; after?: components["parameters"]["pagination-after"]; validity?: components["parameters"]["secret-scanning-alert-validity"]; + is_publicly_leaked?: components["parameters"]["secret-scanning-alert-publicly-leaked"]; + is_multi_repo?: components["parameters"]["secret-scanning-alert-multi-repo"]; }; path: { enterprise: components["parameters"]["enterprise"]; @@ -80690,7 +84057,8 @@ export interface operations { }; /** * 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. + * @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-public-events": { parameters: { @@ -80725,7 +84093,8 @@ export interface operations { * * 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/authentication/authenticating-to-the-rest-api#using-basic-authentication) since current feed URIs use the older, non revocable auth tokens. */ "activity/get-feeds": { responses: { @@ -80767,7 +84136,8 @@ export interface operations { * 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. */ "gists/create": { requestBody: { @@ -81378,10 +84748,8 @@ export interface operations { * 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)." * @@ -81538,7 +84906,7 @@ export interface operations { * 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/authentication/authenticating-to-the-rest-api#using-basic-authentication) with their client ID and client secret to access this endpoint. */ "apps/get-subscription-plan-for-account": { parameters: { @@ -81566,7 +84934,7 @@ export interface operations { * 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/authentication/authenticating-to-the-rest-api#using-basic-authentication) with their client ID and client secret to access this endpoint. */ "apps/list-plans": { parameters: { @@ -81593,7 +84961,7 @@ export interface operations { * 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/authentication/authenticating-to-the-rest-api#using-basic-authentication) with their client ID and client secret to access this endpoint. */ "apps/list-accounts-for-plan": { parameters: { @@ -81627,7 +84995,7 @@ export interface operations { * 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/authentication/authenticating-to-the-rest-api#using-basic-authentication) with their client ID and client secret to access this endpoint. */ "apps/get-subscription-plan-for-account-stubbed": { parameters: { @@ -81653,7 +85021,7 @@ export interface operations { * 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/authentication/authenticating-to-the-rest-api#using-basic-authentication) with their client ID and client secret to access this endpoint. */ "apps/list-plans-stubbed": { parameters: { @@ -81679,7 +85047,7 @@ export interface operations { * 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/authentication/authenticating-to-the-rest-api#using-basic-authentication) with their client ID and client secret to access this endpoint. */ "apps/list-accounts-for-plan-stubbed": { parameters: { @@ -81715,7 +85083,8 @@ export interface operations { * * 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. */ "meta/get": { responses: { @@ -81728,7 +85097,11 @@ export interface operations { 304: components["responses"]["not_modified"]; }; }; - /** List public events for a network of repositories */ + /** + * List public events for a network of repositories + * @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-public-events-for-repo-network": { parameters: { query?: { @@ -81984,7 +85357,8 @@ export interface operations { * 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. */ "orgs/list": { parameters: { @@ -82007,6 +85381,32 @@ export interface operations { 304: components["responses"]["not_modified"]; }; }; + /** + * Get billing usage report for an organization + * @description Gets a report of the total usage for an organization. To use this endpoint, you must be an administrator of an organization within an enterprise or an organization account. + * + * **Note:** This endpoint is only available to organizations with access to the enhanced billing platform. For more information, see "[About the enhanced billing platform](https://docs.github.com/billing/using-the-new-billing-platform)." + */ + "billing/get-github-billing-usage-report-org": { + parameters: { + query?: { + year?: components["parameters"]["billing-usage-report-year"]; + month?: components["parameters"]["billing-usage-report-month"]; + day?: components["parameters"]["billing-usage-report-day"]; + hour?: components["parameters"]["billing-usage-report-hour"]; + }; + path: { + org: components["parameters"]["org"]; + }; + }; + responses: { + 200: components["responses"]["billing_usage_report_org"]; + 400: components["responses"]["bad_request"]; + 403: components["responses"]["forbidden"]; + 500: components["responses"]["internal_error"]; + 503: components["responses"]["service_unavailable"]; + }; + }; /** * Get an organization * @description Gets information about an organization. @@ -82015,17 +85415,6 @@ export interface operations { * * 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. @@ -82070,20 +85459,13 @@ export interface operations { }; /** * 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. + * @description > [!WARNING] + * > **Closing down 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). * - * 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: + * > [!WARNING] + * > **Closing down notice:** Code security product enablement for new repositories through the organization API is closing down. Please use [code security configurations](https://docs.github.com/rest/code-security/configurations#set-a-code-security-configuration-as-a-default-for-an-organization) to set defaults instead. For more information on setting a default security configuration, see the [changelog](https://github.blog/changelog/2024-07-09-sunsetting-security-settings-defaults-parameters-in-the-organizations-rest-api/). * - * - 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)." + * Updates the organization's profile and member privileges. * * The authenticated user must be an organization owner to use this endpoint. * @@ -82135,7 +85517,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 closing down 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"; @@ -82167,7 +85549,10 @@ export interface operations { /** @example "http://github.blog" */ blog?: string; /** - * @description Whether GitHub Advanced Security is automatically enabled for new repositories. + * @deprecated + * @description **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + * + * Whether GitHub Advanced Security is automatically enabled for new repositories and repositories transferred to this 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)." * @@ -82175,7 +85560,10 @@ export interface operations { */ advanced_security_enabled_for_new_repositories?: boolean; /** - * @description Whether Dependabot alerts is automatically enabled for new repositories. + * @deprecated + * @description **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + * + * Whether Dependabot alerts are automatically enabled for new repositories and repositories transferred to this 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)." * @@ -82183,7 +85571,10 @@ export interface operations { */ dependabot_alerts_enabled_for_new_repositories?: boolean; /** - * @description Whether Dependabot security updates is automatically enabled for new repositories. + * @deprecated + * @description **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + * + * Whether Dependabot security updates are automatically enabled for new repositories and repositories transferred to this 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)." * @@ -82191,7 +85582,10 @@ export interface operations { */ dependabot_security_updates_enabled_for_new_repositories?: boolean; /** - * @description Whether dependency graph is automatically enabled for new repositories. + * @deprecated + * @description **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + * + * Whether dependency graph is automatically enabled for new repositories and repositories transferred to this 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)." * @@ -82199,7 +85593,10 @@ export interface operations { */ dependency_graph_enabled_for_new_repositories?: boolean; /** - * @description Whether secret scanning is automatically enabled for new repositories. + * @deprecated + * @description **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + * + * Whether secret scanning is automatically enabled for new repositories and repositories transferred to this 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)." * @@ -82207,7 +85604,10 @@ export interface operations { */ secret_scanning_enabled_for_new_repositories?: boolean; /** - * @description Whether secret scanning push protection is automatically enabled for new repositories. + * @deprecated + * @description **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. + * + * Whether secret scanning push protection is automatically enabled for new repositories and repositories transferred to this 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)." * @@ -82218,6 +85618,8 @@ export interface operations { secret_scanning_push_protection_custom_link_enabled?: boolean; /** @description If `secret_scanning_push_protection_custom_link_enabled` is true, the URL that will be displayed to contributors who are blocked from pushing a secret. */ secret_scanning_push_protection_custom_link?: string; + /** @description Controls whether or not deploy keys may be added and used for repositories in the organization. */ + deploy_keys_enabled_for_repositories?: boolean; }; }; }; @@ -82583,6 +85985,376 @@ export interface operations { }; }; }; + /** + * 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?: { + per_page?: components["parameters"]["per-page"]; + page?: components["parameters"]["page"]; + visible_to_repository?: components["parameters"]["visible-to-repository"]; + }; + path: { + org: components["parameters"]["org"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": { + total_count: number; + runner_groups: components["schemas"]["runner-groups-org"][]; + }; + }; + }; + }; + }; + /** + * 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: { + path: { + org: components["parameters"]["org"]; + }; + }; + requestBody: { + content: { + "application/json": { + /** @description Name of the runner group. */ + name: string; + /** + * @description Visibility of a runner group. You can select all repositories, select individual repositories, or limit access to private repositories. + * @default all + * @enum {string} + */ + visibility?: "selected" | "all" | "private"; + /** @description List of repository IDs that can access the runner group. */ + selected_repository_ids?: number[]; + /** @description List of runner IDs to add to the runner group. */ + runners?: number[]; + /** + * @description Whether the runner group can be used by `public` repositories. + * @default false + */ + allows_public_repositories?: 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; + /** @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[]; + }; + }; + }; + responses: { + /** @description Response */ + 201: { + 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: { + path: { + org: components["parameters"]["org"]; + runner_group_id: components["parameters"]["runner-group-id"]; + }; + }; + responses: { + /** @description Response */ + 200: { + 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: { + path: { + org: components["parameters"]["org"]; + runner_group_id: components["parameters"]["runner-group-id"]; + }; + }; + responses: { + /** @description Response */ + 204: { + 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: { + path: { + org: components["parameters"]["org"]; + runner_group_id: components["parameters"]["runner-group-id"]; + }; + }; + requestBody: { + content: { + "application/json": { + /** @description Name of the runner group. */ + name: string; + /** + * @description Visibility of a runner group. You can select all repositories, select individual repositories, or all private repositories. + * @enum {string} + */ + visibility?: "selected" | "all" | "private"; + /** + * @description Whether the runner group can be used by `public` repositories. + * @default false + */ + allows_public_repositories?: 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; + /** @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[]; + }; + }; + }; + responses: { + /** @description Response */ + 200: { + 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?: { + page?: components["parameters"]["page"]; + per_page?: components["parameters"]["per-page"]; + }; + path: { + org: components["parameters"]["org"]; + runner_group_id: components["parameters"]["runner-group-id"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": { + total_count: number; + repositories: components["schemas"]["minimal-repository"][]; + }; + }; + }; + }; + }; + /** + * 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: { + path: { + org: components["parameters"]["org"]; + runner_group_id: components["parameters"]["runner-group-id"]; + }; + }; + requestBody: { + content: { + "application/json": { + /** @description List of repository IDs that can access the runner group. */ + selected_repository_ids: number[]; + }; + }; + }; + responses: { + /** @description Response */ + 204: { + 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: { + path: { + org: components["parameters"]["org"]; + runner_group_id: components["parameters"]["runner-group-id"]; + repository_id: components["parameters"]["repository-id"]; + }; + }; + responses: { + /** @description Response */ + 204: { + 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: { + path: { + org: components["parameters"]["org"]; + runner_group_id: components["parameters"]["runner-group-id"]; + repository_id: components["parameters"]["repository-id"]; + }; + }; + responses: { + /** @description Response */ + 204: { + 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?: { + per_page?: components["parameters"]["per-page"]; + page?: components["parameters"]["page"]; + }; + path: { + org: components["parameters"]["org"]; + runner_group_id: components["parameters"]["runner-group-id"]; + }; + }; + responses: { + /** @description Response */ + 200: { + headers: { + Link: components["headers"]["link"]; + }; + content: { + "application/json": { + total_count: number; + runners: components["schemas"]["runner"][]; + }; + }; + }; + }; + }; + /** + * 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: { + path: { + org: components["parameters"]["org"]; + runner_group_id: components["parameters"]["runner-group-id"]; + }; + }; + requestBody: { + content: { + "application/json": { + /** @description List of runner IDs to add to the runner group. */ + runners: number[]; + }; + }; + }; + responses: { + /** @description Response */ + 204: { + 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: { + path: { + org: components["parameters"]["org"]; + runner_group_id: components["parameters"]["runner-group-id"]; + runner_id: components["parameters"]["runner-id"]; + }; + }; + responses: { + /** @description Response */ + 204: { + 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: { + path: { + org: components["parameters"]["org"]; + runner_group_id: components["parameters"]["runner-group-id"]; + runner_id: components["parameters"]["runner-id"]; + }; + }; + responses: { + /** @description Response */ + 204: { + content: never; + }; + }; + }; /** * List self-hosted runners for an organization * @description Lists all self-hosted runners configured in an organization. @@ -83536,6 +87308,54 @@ export interface operations { }; }; }; + /** + * List attestations + * @description List a collection of artifact attestations with a given subject digest that are associated with repositories owned by an organization. + * + * The collection of attestations returned by this endpoint is filtered according to the authenticated user's permissions; if the authenticated user cannot read a repository, the attestations associated with that repository will not be included in the response. In addition, when using a fine-grained access token the `attestations:read` permission is required. + * + * **Please note:** in order to offer meaningful security benefits, an attestation's signature and timestamps **must** be cryptographically verified, and the identity of the attestation signer **must** be validated. Attestations can be verified using the [GitHub CLI `attestation verify` command](https://cli.github.com/manual/gh_attestation_verify). For more information, see [our guide on how to use artifact attestations to establish a build's provenance](https://docs.github.com/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds). + */ + "orgs/list-attestations": { + parameters: { + query?: { + per_page?: components["parameters"]["per-page"]; + before?: components["parameters"]["pagination-before"]; + after?: components["parameters"]["pagination-after"]; + }; + path: { + org: components["parameters"]["org"]; + /** @description The parameter should be set to the attestation's subject's SHA256 digest, in the form `sha256:HEX_DIGEST`. */ + subject_digest: string; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": { + attestations?: { + /** + * @description The attestation's Sigstore Bundle. + * Refer to the [Sigstore Bundle Specification](https://github.com/sigstore/protobuf-specs/blob/main/protos/sigstore_bundle.proto) for more information. + */ + bundle?: { + mediaType?: string; + verificationMaterial?: { + [key: string]: unknown; + }; + dsseEnvelope?: { + [key: string]: unknown; + }; + }; + repository_id?: number; + bundle_url?: string; + }[]; + }; + }; + }; + }; + }; /** * List users blocked by an organization * @description List the users blocked by an organization. @@ -83663,6 +87483,546 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; + /** + * Get code security configurations for an organization + * @description Lists all code security configurations available in an 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 `write:org` scope to use this endpoint. + */ + "code-security/get-configurations-for-org": { + parameters: { + query?: { + /** @description The target type of the code security configuration */ + target_type?: "global" | "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?: number; + before?: components["parameters"]["pagination-before"]; + after?: components["parameters"]["pagination-after"]; + }; + path: { + org: components["parameters"]["org"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["code-security-configuration"][]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + /** + * Create a code security configuration + * @description Creates a code security configuration in an 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 `write:org` scope to use this endpoint. + */ + "code-security/create-configuration": { + parameters: { + path: { + org: components["parameters"]["org"]; + }; + }; + requestBody: { + content: { + "application/json": { + /** @description The name of the code security configuration. Must be unique within the organization. */ + name: string; + /** @description A description of the code security configuration */ + description: string; + /** + * @description The enablement status of GitHub Advanced Security + * @default disabled + * @enum {string} + */ + advanced_security?: "enabled" | "disabled"; + /** + * @description The enablement status of Dependency Graph + * @default enabled + * @enum {string} + */ + dependency_graph?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Automatic dependency submission + * @default disabled + * @enum {string} + */ + dependency_graph_autosubmit_action?: + | "enabled" + | "disabled" + | "not_set"; + /** @description Feature options for Automatic dependency submission */ + dependency_graph_autosubmit_action_options?: { + /** + * @description Whether to use runners labeled with 'dependency-submission' or standard GitHub runners. + * @default false + */ + labeled_runners?: boolean; + }; + /** + * @description The enablement status of Dependabot alerts + * @default disabled + * @enum {string} + */ + dependabot_alerts?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Dependabot security updates + * @default disabled + * @enum {string} + */ + dependabot_security_updates?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of code scanning default setup + * @default disabled + * @enum {string} + */ + code_scanning_default_setup?: "enabled" | "disabled" | "not_set"; + code_scanning_default_setup_options?: components["schemas"]["code-scanning-default-setup-options"]; + /** + * @description The enablement status of secret scanning + * @default disabled + * @enum {string} + */ + secret_scanning?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning push protection + * @default disabled + * @enum {string} + */ + secret_scanning_push_protection?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning delegated bypass + * @default disabled + * @enum {string} + */ + secret_scanning_delegated_bypass?: "enabled" | "disabled" | "not_set"; + /** @description Feature options for secret scanning delegated bypass */ + secret_scanning_delegated_bypass_options?: { + /** @description The bypass reviewers for secret scanning delegated bypass */ + reviewers?: { + /** @description The ID of the team or role selected as a bypass reviewer */ + reviewer_id: number; + /** + * @description The type of the bypass reviewer + * @enum {string} + */ + reviewer_type: "TEAM" | "ROLE"; + }[]; + }; + /** + * @description The enablement status of secret scanning validity checks + * @default disabled + * @enum {string} + */ + secret_scanning_validity_checks?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning non provider patterns + * @default disabled + * @enum {string} + */ + secret_scanning_non_provider_patterns?: + | "enabled" + | "disabled" + | "not_set"; + /** + * @description The enablement status of private vulnerability reporting + * @default disabled + * @enum {string} + */ + private_vulnerability_reporting?: "enabled" | "disabled" | "not_set"; + /** + * @description The enforcement status for a security configuration + * @default enforced + * @enum {string} + */ + enforcement?: "enforced" | "unenforced"; + }; + }; + }; + responses: { + /** @description Successfully created code security configuration */ + 201: { + content: { + "application/json": components["schemas"]["code-security-configuration"]; + }; + }; + }; + }; + /** + * Get default code security configurations + * @description Lists the default code security configurations for an 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 `write:org` scope to use this endpoint. + */ + "code-security/get-default-configurations": { + parameters: { + path: { + org: components["parameters"]["org"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["code-security-default-configurations"]; + }; + }; + 304: components["responses"]["not_modified"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + /** + * Detach configurations from repositories + * @description Detach code security configuration(s) from a set of repositories. + * Repositories will retain their settings but will no longer be associated with the configuration. + * + * 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 `write:org` scope to use this endpoint. + */ + "code-security/detach-configuration": { + parameters: { + path: { + org: components["parameters"]["org"]; + }; + }; + requestBody: { + content: { + "application/json": { + /** @description An array of repository IDs to detach from configurations. */ + selected_repository_ids?: number[]; + }; + }; + }; + responses: { + 204: components["responses"]["no_content"]; + 400: components["responses"]["bad_request"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; + }; + }; + /** + * Get a code security configuration + * @description Gets a code security configuration available in an 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 `write:org` scope to use this endpoint. + */ + "code-security/get-configuration": { + parameters: { + path: { + org: components["parameters"]["org"]; + configuration_id: components["parameters"]["configuration-id"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["code-security-configuration"]; + }; + }; + 304: components["responses"]["not_modified"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + /** + * Delete a code security configuration + * @description Deletes the desired code security configuration from an organization. + * Repositories attached to the configuration will retain their settings but will no longer be associated with + * the configuration. + * + * 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 `write:org` scope to use this endpoint. + */ + "code-security/delete-configuration": { + parameters: { + path: { + org: components["parameters"]["org"]; + configuration_id: components["parameters"]["configuration-id"]; + }; + }; + responses: { + 204: components["responses"]["no_content"]; + 400: components["responses"]["bad_request"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; + }; + }; + /** + * Update a code security configuration + * @description Updates a code security configuration in an 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 `write:org` scope to use this endpoint. + */ + "code-security/update-configuration": { + parameters: { + path: { + org: components["parameters"]["org"]; + configuration_id: components["parameters"]["configuration-id"]; + }; + }; + requestBody: { + content: { + "application/json": { + /** @description The name of the code security configuration. Must be unique within the organization. */ + name?: string; + /** @description A description of the code security configuration */ + description?: string; + /** + * @description The enablement status of GitHub Advanced Security + * @enum {string} + */ + advanced_security?: "enabled" | "disabled"; + /** + * @description The enablement status of Dependency Graph + * @enum {string} + */ + dependency_graph?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Automatic dependency submission + * @enum {string} + */ + dependency_graph_autosubmit_action?: + | "enabled" + | "disabled" + | "not_set"; + /** @description Feature options for Automatic dependency submission */ + dependency_graph_autosubmit_action_options?: { + /** @description Whether to use runners labeled with 'dependency-submission' or standard GitHub runners. */ + labeled_runners?: boolean; + }; + /** + * @description The enablement status of Dependabot alerts + * @enum {string} + */ + dependabot_alerts?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Dependabot security updates + * @enum {string} + */ + dependabot_security_updates?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of code scanning default setup + * @enum {string} + */ + code_scanning_default_setup?: "enabled" | "disabled" | "not_set"; + code_scanning_default_setup_options?: components["schemas"]["code-scanning-default-setup-options"]; + /** + * @description The enablement status of secret scanning + * @enum {string} + */ + secret_scanning?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning push protection + * @enum {string} + */ + secret_scanning_push_protection?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning delegated bypass + * @enum {string} + */ + secret_scanning_delegated_bypass?: "enabled" | "disabled" | "not_set"; + /** @description Feature options for secret scanning delegated bypass */ + secret_scanning_delegated_bypass_options?: { + /** @description The bypass reviewers for secret scanning delegated bypass */ + reviewers?: { + /** @description The ID of the team or role selected as a bypass reviewer */ + reviewer_id: number; + /** + * @description The type of the bypass reviewer + * @enum {string} + */ + reviewer_type: "TEAM" | "ROLE"; + }[]; + }; + /** + * @description The enablement status of secret scanning validity checks + * @enum {string} + */ + secret_scanning_validity_checks?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning non-provider patterns + * @enum {string} + */ + secret_scanning_non_provider_patterns?: + | "enabled" + | "disabled" + | "not_set"; + /** + * @description The enablement status of private vulnerability reporting + * @enum {string} + */ + private_vulnerability_reporting?: "enabled" | "disabled" | "not_set"; + /** + * @description The enforcement status for a security configuration + * @enum {string} + */ + enforcement?: "enforced" | "unenforced"; + }; + }; + }; + responses: { + /** @description Response when a configuration is updated */ + 200: { + content: { + "application/json": components["schemas"]["code-security-configuration"]; + }; + }; + /** @description Response when no new updates are made */ + 204: { + content: never; + }; + }; + }; + /** + * Attach a configuration to repositories + * @description Attach a code security configuration to a set of repositories. If the repositories specified are already attached to a configuration, they will be re-attached to the provided configuration. + * + * If insufficient GHAS licenses are available to attach the configuration to a repository, only free features will be enabled. + * + * 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 `write:org` scope to use this endpoint. + */ + "code-security/attach-configuration": { + parameters: { + path: { + org: components["parameters"]["org"]; + configuration_id: components["parameters"]["configuration-id"]; + }; + }; + requestBody: { + content: { + "application/json": { + /** + * @description The type of repositories to attach the configuration to. `selected` means the configuration will be attached to only the repositories specified by `selected_repository_ids` + * @enum {string} + */ + scope: + | "all" + | "all_without_configurations" + | "public" + | "private_or_internal" + | "selected"; + /** @description An array of repository IDs to attach the configuration to. You can only provide a list of repository ids when the `scope` is set to `selected`. */ + selected_repository_ids?: number[]; + }; + }; + }; + responses: { + 202: components["responses"]["accepted"]; + }; + }; + /** + * Set a code security configuration as a default for an organization + * @description Sets a code security configuration as a default to be applied to new repositories in your organization. + * + * This configuration will be applied to the matching repository type (all, none, public, private and internal) by default when they are created. + * + * 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 `write:org` scope to use this endpoint. + */ + "code-security/set-configuration-as-default": { + parameters: { + path: { + org: components["parameters"]["org"]; + configuration_id: components["parameters"]["configuration-id"]; + }; + }; + requestBody: { + content: { + "application/json": { + /** + * @description Specify which types of repository this security configuration should be applied to by default. + * @enum {string} + */ + default_for_new_repos?: + | "all" + | "none" + | "private_and_internal" + | "public"; + }; + }; + }; + responses: { + /** @description Default successfully changed. */ + 200: { + content: { + "application/json": { + /** + * @description Specifies which types of repository this security configuration is applied to by default. + * @enum {string} + */ + default_for_new_repos?: + | "all" + | "none" + | "private_and_internal" + | "public"; + configuration?: components["schemas"]["code-security-configuration"]; + }; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + /** + * Get repositories associated with a code security configuration + * @description Lists the repositories associated with a code security configuration in an 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 `write:org` scope to use this endpoint. + */ + "code-security/get-repositories-for-configuration": { + parameters: { + 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?: number; + before?: components["parameters"]["pagination-before"]; + after?: components["parameters"]["pagination-after"]; + /** + * @description A comma-separated list of statuses. If specified, only repositories with these attachment statuses will be returned. + * + * Can be: `all`, `attached`, `attaching`, `detached`, `removed`, `enforced`, `failed`, `updating`, `removed_by_enterprise` + */ + status?: string; + }; + path: { + org: components["parameters"]["org"]; + configuration_id: components["parameters"]["configuration-id"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["code-security-configuration-repositories"][]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; /** * List codespaces for the organization * @description Lists the codespaces associated to a specified organization. @@ -84085,15 +88445,16 @@ export interface operations { }; /** * Get Copilot seat information and settings for an organization - * @description **Note**: This endpoint is in beta and is subject to change. + * @description > [!NOTE] + * > This endpoint is in public preview 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)". + * and feature 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 view details about the organization's Copilot Business or Copilot 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 either the `manage_billing:copilot` or `read:org` scopes to use this endpoint. */ "copilot/get-copilot-organization-details": { parameters: { @@ -84120,13 +88481,16 @@ export interface operations { }; /** * List all Copilot seat assignments for an organization - * @description **Note**: This endpoint is in beta and is subject to change. + * @description > [!NOTE] + * > This endpoint is in public preview 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 seats for which an organization with a Copilot Business or Copilot Enterprise subscription is currently being billed. + * Only organization owners can view assigned seats. * - * Only organization owners can configure and view details about the organization's Copilot Business or Enterprise subscription. + * Each seat object contains information about the assigned user's most recent Copilot activity. Users must have telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`. + * For more information about activity data, see "[Reviewing user activity data for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-user-activity-data-for-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 either the `manage_billing:copilot` or `read:org` scopes to use this endpoint. */ "copilot/list-copilot-seats": { parameters: { @@ -84161,18 +88525,19 @@ export interface operations { }; /** * Add teams to the Copilot subscription for an organization - * @description **Note**: This endpoint is in beta and is subject to change. + * @description > [!NOTE] + * > This endpoint is in public preview 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)". + * The organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see "[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization)." * - * Only organization owners can configure GitHub Copilot in their organization. + * Only organization owners can purchase Copilot seats for their organization members. The organization must have a Copilot Business or Copilot Enterprise subscription and a configured suggestion matching policy. + * For more information about setting up a Copilot subscription, see "[Subscribing to Copilot for your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/subscribing-to-copilot-for-your-organization)." + * For more information about setting a suggestion matching policy, see "[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching)." * - * 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)". + * The response contains the total number of new seats that were created and existing seats that were refreshed. * - * 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 either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. */ "copilot/add-copilot-seats-for-teams": { parameters: { @@ -84209,18 +88574,18 @@ export interface operations { }; /** * 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. + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. * - * 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)". + * Sets seats for all members of each team specified to "pending cancellation". + * This will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through another team. + * For more information about disabling access to Copilot, see "[Revoking access to Copilot for members of your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-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 cancel Copilot seats for their organization members. * - * Only organization owners can configure GitHub Copilot in their organization. + * The response contains the total number of seats set to "pending cancellation". * - * 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 either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. */ "copilot/cancel-copilot-seat-assignment-for-teams": { parameters: { @@ -84257,18 +88622,19 @@ export interface operations { }; /** * Add users to the Copilot subscription for an organization - * @description **Note**: This endpoint is in beta and is subject to change. + * @description > [!NOTE] + * > This endpoint is in public preview 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)". + * The organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see "[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization)." * - * Only organization owners can configure GitHub Copilot in their organization. + * Only organization owners can purchase Copilot seats for their organization members. The organization must have a Copilot Business or Copilot Enterprise subscription and a configured suggestion matching policy. + * For more information about setting up a Copilot subscription, see "[Subscribing to Copilot for your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/subscribing-to-copilot-for-your-organization)." + * For more information about setting a suggestion matching policy, see "[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching)." * - * 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)". + * The response contains the total number of new seats that were created and existing seats that were refreshed. * - * 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 either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. */ "copilot/add-copilot-seats-for-users": { parameters: { @@ -84305,18 +88671,18 @@ export interface operations { }; /** * Remove users from the Copilot subscription for an organization - * @description **Note**: This endpoint is in beta and is subject to change. + * @description > [!NOTE] + * > This endpoint is in public preview 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. + * Sets seats for all users specified to "pending cancellation". + * This will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through team membership. + * For more information about disabling access to Copilot, see "[Revoking access to Copilot for members of your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization)." * - * 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 cancel Copilot seats for their organization members. * - * 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)". + * The response contains the total number of seats set to "pending cancellation". * - * 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 either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. */ "copilot/cancel-copilot-seat-assignment-for-users": { parameters: { @@ -84351,22 +88717,66 @@ export interface operations { 500: components["responses"]["internal_error"]; }; }; + /** + * Get Copilot metrics for an organization + * @description Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions. + * + * > [!NOTE] + * > This endpoint will only return results for a given day if the organization contained **five or more members with active Copilot licenses** on that day, as evaluated at the end of that day. + * + * The response contains metrics for up to 28 days prior. 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. + * + * To access this endpoint, the Copilot Metrics API access policy must be enabled for the organization. + * Only organization owners and owners and billing managers of the parent enterprise can view Copilot metrics. + * + * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot`, `read:org`, or `read:enterprise` scopes to use this endpoint. + */ + "copilot/copilot-metrics-for-organization": { + parameters: { + query?: { + /** @description Show usage metrics since this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). Maximum value is 28 days ago. */ + 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; + 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; + }; + path: { + org: components["parameters"]["org"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["copilot-usage-metrics-day"][]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["usage_metrics_api_disabled"]; + 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. + * @description > [!NOTE] + * > This endpoint is in public preview 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, + * The response contains metrics for up to 28 days prior. 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. + * Organization owners, and owners and billing managers of the parent enterprise, 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 either the `manage_billing:copilot`, `read:org`, or `read:enterprise` scopes to use this endpoint. */ "copilot/usage-metrics-for-org": { parameters: { @@ -84786,7 +89196,11 @@ export interface operations { 403: components["responses"]["forbidden"]; }; }; - /** List public organization events */ + /** + * List public organization 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-public-org-events": { parameters: { query?: { @@ -84835,7 +89249,9 @@ export interface operations { }; /** * List organization webhooks - * @description You must be an organization owner to use this endpoint. + * @description List webhooks for an organization. + * + * The authenticated user 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. @@ -84953,7 +89369,9 @@ export interface operations { }; /** * Delete an organization webhook - * @description You must be an organization owner to use this endpoint. + * @description Delete a webhook for an organization. + * + * The authenticated user 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. @@ -85105,7 +89523,6 @@ export interface operations { query?: { per_page?: components["parameters"]["per-page"]; cursor?: components["parameters"]["cursor"]; - redelivery?: boolean; }; path: { org: components["parameters"]["org"]; @@ -85199,6 +89616,240 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; + /** + * Get route stats by actor + * @description Get API request count statistics for an actor broken down by route within a specified time frame. + */ + "api-insights/get-route-stats-by-actor": { + parameters: { + query: { + min_timestamp: components["parameters"]["api-insights-min-timestamp"]; + max_timestamp?: components["parameters"]["api-insights-max-timestamp"]; + page?: components["parameters"]["page"]; + per_page?: components["parameters"]["per-page"]; + direction?: components["parameters"]["direction"]; + sort?: components["parameters"]["api-insights-route-stats-sort"]; + api_route_substring?: components["parameters"]["api-insights-api-route-substring"]; + }; + path: { + org: components["parameters"]["org"]; + actor_type: components["parameters"]["api-insights-actor-type"]; + actor_id: components["parameters"]["api-insights-actor-id"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["api-insights-route-stats"]; + }; + }; + }; + }; + /** + * Get subject stats + * @description Get API request statistics for all subjects within an organization within a specified time frame. Subjects can be users or GitHub Apps. + */ + "api-insights/get-subject-stats": { + parameters: { + query: { + min_timestamp: components["parameters"]["api-insights-min-timestamp"]; + max_timestamp?: components["parameters"]["api-insights-max-timestamp"]; + page?: components["parameters"]["page"]; + per_page?: components["parameters"]["per-page"]; + direction?: components["parameters"]["direction"]; + sort?: components["parameters"]["api-insights-sort"]; + subject_name_substring?: components["parameters"]["api-insights-subject-name-substring"]; + }; + path: { + org: components["parameters"]["org"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["api-insights-subject-stats"]; + }; + }; + }; + }; + /** + * Get summary stats + * @description Get overall statistics of API requests made within an organization by all users and apps within a specified time frame. + */ + "api-insights/get-summary-stats": { + parameters: { + query: { + min_timestamp: components["parameters"]["api-insights-min-timestamp"]; + max_timestamp?: components["parameters"]["api-insights-max-timestamp"]; + }; + path: { + org: components["parameters"]["org"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["api-insights-summary-stats"]; + }; + }; + }; + }; + /** + * Get summary stats by user + * @description Get overall statistics of API requests within the organization for a user. + */ + "api-insights/get-summary-stats-by-user": { + parameters: { + query: { + min_timestamp: components["parameters"]["api-insights-min-timestamp"]; + max_timestamp?: components["parameters"]["api-insights-max-timestamp"]; + }; + path: { + org: components["parameters"]["org"]; + user_id: components["parameters"]["api-insights-user-id"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["api-insights-summary-stats"]; + }; + }; + }; + }; + /** + * Get summary stats by actor + * @description Get overall statistics of API requests within the organization made by a specific actor. Actors can be GitHub App installations, OAuth apps or other tokens on behalf of a user. + */ + "api-insights/get-summary-stats-by-actor": { + parameters: { + query: { + min_timestamp: components["parameters"]["api-insights-min-timestamp"]; + max_timestamp?: components["parameters"]["api-insights-max-timestamp"]; + }; + path: { + org: components["parameters"]["org"]; + actor_type: components["parameters"]["api-insights-actor-type"]; + actor_id: components["parameters"]["api-insights-actor-id"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["api-insights-summary-stats"]; + }; + }; + }; + }; + /** + * Get time stats + * @description Get the number of API requests and rate-limited requests made within an organization over a specified time period. + */ + "api-insights/get-time-stats": { + parameters: { + query: { + min_timestamp: components["parameters"]["api-insights-min-timestamp"]; + max_timestamp?: components["parameters"]["api-insights-max-timestamp"]; + timestamp_increment: components["parameters"]["api-insights-timestamp-increment"]; + }; + path: { + org: components["parameters"]["org"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["api-insights-time-stats"]; + }; + }; + }; + }; + /** + * Get time stats by user + * @description Get the number of API requests and rate-limited requests made within an organization by a specific user over a specified time period. + */ + "api-insights/get-time-stats-by-user": { + parameters: { + query: { + min_timestamp: components["parameters"]["api-insights-min-timestamp"]; + max_timestamp?: components["parameters"]["api-insights-max-timestamp"]; + timestamp_increment: components["parameters"]["api-insights-timestamp-increment"]; + }; + path: { + org: components["parameters"]["org"]; + user_id: components["parameters"]["api-insights-user-id"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["api-insights-time-stats"]; + }; + }; + }; + }; + /** + * Get time stats by actor + * @description Get the number of API requests and rate-limited requests made within an organization by a specific actor within a specified time period. + */ + "api-insights/get-time-stats-by-actor": { + parameters: { + query: { + min_timestamp: components["parameters"]["api-insights-min-timestamp"]; + max_timestamp?: components["parameters"]["api-insights-max-timestamp"]; + timestamp_increment: components["parameters"]["api-insights-timestamp-increment"]; + }; + path: { + org: components["parameters"]["org"]; + actor_type: components["parameters"]["api-insights-actor-type"]; + actor_id: components["parameters"]["api-insights-actor-id"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["api-insights-time-stats"]; + }; + }; + }; + }; + /** + * Get user stats + * @description Get API usage statistics within an organization for a user broken down by the type of access. + */ + "api-insights/get-user-stats": { + parameters: { + query: { + min_timestamp: components["parameters"]["api-insights-min-timestamp"]; + max_timestamp?: components["parameters"]["api-insights-max-timestamp"]; + page?: components["parameters"]["page"]; + per_page?: components["parameters"]["per-page"]; + direction?: components["parameters"]["direction"]; + sort?: components["parameters"]["api-insights-sort"]; + actor_name_substring?: components["parameters"]["api-insights-actor-name-substring"]; + }; + path: { + org: components["parameters"]["org"]; + user_id: components["parameters"]["api-insights-user-id"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["api-insights-user-stats"]; + }; + }; + }; + }; /** * Get an organization installation for the authenticated app * @description Enables an authenticated GitHub App to find the organization's installation information. @@ -85319,7 +89970,10 @@ export interface operations { }; /** * 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`. + * @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: { @@ -85357,7 +90011,7 @@ export interface operations { * 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)" + * 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/using-the-rest-api/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": { @@ -85453,10 +90107,8 @@ 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/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)." * @@ -85670,13 +90322,17 @@ export interface operations { }; /** * Get Copilot seat assignment details for a user - * @description **Note**: This endpoint is in beta and is subject to change. + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. + * + * Gets the GitHub Copilot seat 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. + * The seat object contains information about the user's most recent Copilot activity. Users must have telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`. + * For more information about activity data, see "[Reviewing user activity data for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-user-activity-data-for-copilot-in-your-organization)." * - * Organization owners can view GitHub Copilot seat assignment details for members in their organization. + * Only organization owners can view Copilot seat assignment details for members of 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 either the `manage_billing:copilot` or `read:org` scopes to use this endpoint. */ "copilot/get-copilot-seat-details-for-user": { parameters: { @@ -85734,7 +90390,7 @@ export interface operations { * * **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, organization owners are limited to creating 50 organization invitations for an organization within a 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: { @@ -86014,39 +90670,9 @@ 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: { - path: { - org: components["parameters"]["org"]; - }; - }; - responses: { - /** @description Response */ - 200: { - content: { - "application/json": components["schemas"]["organization-fine-grained-permission"][]; - }; - }; - 404: components["responses"]["not_found"]; - 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)." + * @description Lists the organization roles available in this organization. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." * * To use this endpoint, the authenticated user must be one of: * @@ -86077,50 +90703,9 @@ 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: { - path: { - org: components["parameters"]["org"]; - }; - }; - requestBody: { - content: { - "application/json": { - /** @description The name of the custom role. */ - name: string; - /** @description A short description about the intended usage of this role or what permissions it grants. */ - description?: string; - /** @description A list of additional permissions included in this role. */ - permissions: string[]; - }; - }; - }; - responses: { - /** @description Response */ - 201: { - content: { - "application/json": components["schemas"]["organization-role"]; - }; - }; - 404: components["responses"]["not_found"]; - 409: components["responses"]["conflict"]; - 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)." + * @description Removes all assigned organization roles from a team. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." * * The authenticated user must be an administrator for the organization to use this endpoint. * @@ -86142,7 +90727,7 @@ export interface operations { }; /** * 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)." + * @description Assigns an organization role to a team in an organization. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." * * The authenticated user must be an administrator for the organization to use this endpoint. * @@ -86173,7 +90758,7 @@ export interface operations { }; /** * 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)." + * @description Removes an organization role from a team. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." * * The authenticated user must be an administrator for the organization to use this endpoint. * @@ -86196,7 +90781,7 @@ export interface operations { }; /** * 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)." + * @description Revokes all assigned organization roles from a user. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." * * The authenticated user must be an administrator for the organization to use this endpoint. * @@ -86218,7 +90803,7 @@ export interface operations { }; /** * 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)." + * @description Assigns an organization role to a member of an organization. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." * * The authenticated user must be an administrator for the organization to use this endpoint. * @@ -86249,7 +90834,7 @@ export interface operations { }; /** * 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)." + * @description Remove an organization role from a user. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." * * The authenticated user must be an administrator for the organization to use this endpoint. * @@ -86272,7 +90857,7 @@ export interface operations { }; /** * 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)." + * @description Gets an organization role that is available to this organization. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." * * To use this endpoint, the authenticated user must be one of: * @@ -86299,77 +90884,9 @@ 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: { - path: { - org: components["parameters"]["org"]; - role_id: components["parameters"]["role-id"]; - }; - }; - 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. - */ - "orgs/patch-custom-organization-role": { - parameters: { - path: { - org: components["parameters"]["org"]; - role_id: components["parameters"]["role-id"]; - }; - }; - requestBody: { - content: { - "application/json": { - /** @description The name of the custom role. */ - name?: string; - /** @description A short description about the intended usage of this role or what permissions it grants. */ - description?: string; - /** @description A list of additional permissions included in this role. */ - permissions?: string[]; - }; - }; - }; - responses: { - /** @description Response */ - 200: { - content: { - "application/json": components["schemas"]["organization-role"]; - }; - }; - 404: components["responses"]["not_found"]; - 409: components["responses"]["conflict"]; - 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)." + * @description Lists the teams that are assigned to an organization role. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." * * To use this endpoint, you must be an administrator for the organization. * @@ -86393,7 +90910,7 @@ export interface operations { Link: components["headers"]["link"]; }; content: { - "application/json": components["schemas"]["team"][]; + "application/json": components["schemas"]["team-role-assignment"][]; }; }; /** @description Response if the organization or role does not exist. */ @@ -86408,7 +90925,7 @@ export interface operations { }; /** * 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)." + * @description Lists organization members that are assigned to an organization role. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." * * To use this endpoint, you must be an administrator for the organization. * @@ -86432,7 +90949,7 @@ export interface operations { Link: components["headers"]["link"]; }; content: { - "application/json": components["schemas"]["simple-user"][]; + "application/json": components["schemas"]["user-role-assignment"][]; }; }; /** @description Response if the organization or role does not exist. */ @@ -86544,7 +91061,7 @@ 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)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, 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: { @@ -86583,7 +91100,7 @@ export interface operations { * 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. For more information, 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: { @@ -86608,7 +91125,7 @@ export interface operations { * * 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. For more information, 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: { @@ -86638,7 +91155,7 @@ export interface operations { * * 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. For more information, 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: { @@ -86666,7 +91183,7 @@ export interface operations { * 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 `read:packages` scope to use this endpoint. For more information, 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: { @@ -86698,7 +91215,7 @@ export interface operations { * 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. For more information, 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: { @@ -86724,7 +91241,7 @@ export interface operations { * * 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. For more information, 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: { @@ -86755,7 +91272,7 @@ export interface operations { * * 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. For more information, 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: { @@ -87055,6 +91572,232 @@ export interface operations { 500: components["responses"]["internal_error"]; }; }; + /** + * List private registries for an organization + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. + * + * Lists all private registry configurations 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. + */ + "private-registries/list-org-private-registries": { + parameters: { + query?: { + per_page?: components["parameters"]["per-page"]; + page?: components["parameters"]["page"]; + }; + path: { + org: components["parameters"]["org"]; + }; + }; + responses: { + /** @description Response */ + 200: { + headers: { + Link: components["headers"]["link"]; + }; + content: { + "application/json": { + total_count: number; + configurations: components["schemas"]["org-private-registry-configuration"][]; + }; + }; + }; + 400: components["responses"]["bad_request"]; + 404: components["responses"]["not_found"]; + }; + }; + /** + * Create a private registry for an organization + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. + * + * Creates a private registry configuration with an encrypted value for an organization. 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. + */ + "private-registries/create-org-private-registry": { + parameters: { + path: { + org: components["parameters"]["org"]; + }; + }; + requestBody: { + content: { + "application/json": { + /** + * @description The registry type. + * @enum {string} + */ + registry_type: "maven_repository"; + /** @description The username to use when authenticating with the private registry. This field should be omitted if the private registry does not require a username for authentication. */ + username?: string | null; + /** @description The value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get private registries public key for an organization](https://docs.github.com/rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization) endpoint. */ + encrypted_value: string; + /** @description The ID of the key you used to encrypt the secret. */ + key_id: string; + /** + * @description Which type of organization repositories have access to the private registry. `selected` means only the repositories specified by `selected_repository_ids` can access the private registry. + * @enum {string} + */ + visibility: "all" | "private" | "selected"; + /** @description An array of repository IDs that can access the organization private registry. You can only provide a list of repository IDs when `visibility` is set to `selected`. You can manage the list of selected repositories using the [Update a private registry for an organization](https://docs.github.com/rest/private-registries/organization-configurations#update-a-private-registry-for-an-organization) endpoint. This field should be omitted if `visibility` is set to `all` or `private`. */ + selected_repository_ids?: number[]; + }; + }; + }; + responses: { + /** @description The organization private registry configuration */ + 201: { + content: { + "application/json": components["schemas"]["org-private-registry-configuration-with-selected-repositories"]; + }; + }; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + }; + }; + /** + * Get private registries public key for an organization + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. + * + * Gets the org public key, which is needed to encrypt private registry secrets. You need to encrypt a secret before you can create or update secrets. + * + * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + "private-registries/get-org-public-key": { + parameters: { + path: { + org: components["parameters"]["org"]; + }; + }; + responses: { + /** @description Response */ + 200: { + headers: { + Link: components["headers"]["link"]; + }; + content: { + "application/json": { + /** + * @description The identifier for the key. + * @example 012345678912345678 + */ + key_id: string; + /** + * @description The Base64 encoded public key. + * @example 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 + */ + key: string; + }; + }; + }; + 404: components["responses"]["not_found"]; + }; + }; + /** + * Get a private registry for an organization + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. + * + * Get the configuration of a single private registry defined for an organization, omitting its encrypted value. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + "private-registries/get-org-private-registry": { + parameters: { + path: { + org: components["parameters"]["org"]; + secret_name: components["parameters"]["secret-name"]; + }; + }; + responses: { + /** @description The specified private registry configuration for the organization */ + 200: { + content: { + "application/json": components["schemas"]["org-private-registry-configuration"]; + }; + }; + 404: components["responses"]["not_found"]; + }; + }; + /** + * Delete a private registry for an organization + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. + * + * Delete a private registry configuration at the organization-level. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + "private-registries/delete-org-private-registry": { + parameters: { + path: { + org: components["parameters"]["org"]; + secret_name: components["parameters"]["secret-name"]; + }; + }; + responses: { + /** @description Response */ + 204: { + content: never; + }; + 400: components["responses"]["bad_request"]; + 404: components["responses"]["not_found"]; + }; + }; + /** + * Update a private registry for an organization + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. + * + * Updates a private registry configuration with an encrypted value for an organization. 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. + */ + "private-registries/update-org-private-registry": { + parameters: { + path: { + org: components["parameters"]["org"]; + secret_name: components["parameters"]["secret-name"]; + }; + }; + requestBody: { + content: { + "application/json": { + /** + * @description The registry type. + * @enum {string} + */ + registry_type?: "maven_repository"; + /** @description The username to use when authenticating with the private registry. This field should be omitted if the private registry does not require a username for authentication. */ + username?: string | null; + /** @description The value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get private registries public key for an organization](https://docs.github.com/rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization) endpoint. */ + encrypted_value?: string; + /** @description The ID of the key you used to encrypt the secret. */ + key_id?: string; + /** + * @description Which type of organization repositories have access to the private registry. `selected` means only the repositories specified by `selected_repository_ids` can access the private registry. + * @enum {string} + */ + visibility?: "all" | "private" | "selected"; + /** @description An array of repository IDs that can access the organization private registry. You can only provide a list of repository IDs when `visibility` is set to `selected`. This field should be omitted if `visibility` is set to `all` or `private`. */ + selected_repository_ids?: number[]; + }; + }; + }; + responses: { + /** @description Response */ + 204: { + content: never; + }; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + }; + }; /** * 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. @@ -87133,7 +91876,7 @@ export interface operations { /** @description Response */ 200: { content: { - "application/json": components["schemas"]["org-custom-property"][]; + "application/json": components["schemas"]["custom-property"][]; }; }; 403: components["responses"]["forbidden"]; @@ -87158,7 +91901,7 @@ export interface operations { content: { "application/json": { /** @description The array of custom properties to create or update. */ - properties: components["schemas"]["org-custom-property"][]; + properties: components["schemas"]["custom-property"][]; }; }; }; @@ -87166,7 +91909,7 @@ export interface operations { /** @description Response */ 200: { content: { - "application/json": components["schemas"]["org-custom-property"][]; + "application/json": components["schemas"]["custom-property"][]; }; }; 403: components["responses"]["forbidden"]; @@ -87189,7 +91932,7 @@ export interface operations { /** @description Response */ 200: { content: { - "application/json": components["schemas"]["org-custom-property"]; + "application/json": components["schemas"]["custom-property"]; }; }; 403: components["responses"]["forbidden"]; @@ -87213,32 +91956,14 @@ export interface operations { }; requestBody: { content: { - "application/json": { - /** - * @description The type of the value for the property - * @example single_select - * @enum {string} - */ - value_type: "string" | "single_select"; - /** @description Whether the property is required. */ - required?: boolean; - /** @description Default value of the property */ - 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. - */ - allowed_values?: string[] | null; - }; + "application/json": components["schemas"]["custom-property-set-payload"]; }; }; responses: { /** @description Response */ 200: { content: { - "application/json": components["schemas"]["org-custom-property"]; + "application/json": components["schemas"]["custom-property"]; }; }; 403: components["responses"]["forbidden"]; @@ -87427,7 +92152,8 @@ export interface operations { * 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)." */ "repos/list-for-org": { parameters: { @@ -87552,12 +92278,14 @@ export interface operations { delete_branch_on_merge?: boolean; /** * @deprecated - * @description Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; /** - * @description The default value for a squash merge commit title: + * @description Required when using `squash_merge_commit_message`. + * + * The default value for a squash merge commit title: * * - `PR_TITLE` - default to the pull request's title. * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). @@ -87574,7 +92302,9 @@ export interface operations { */ squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** - * @description The default value for a merge commit title. + * @description Required when using `merge_commit_message`. + * + * The default value for a merge commit title. * * - `PR_TITLE` - default to the pull request's title. * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). @@ -87621,6 +92351,7 @@ export interface operations { query?: { per_page?: components["parameters"]["per-page"]; page?: components["parameters"]["page"]; + targets?: components["parameters"]["ruleset-targets"]; }; path: { org: components["parameters"]["org"]; @@ -87655,11 +92386,10 @@ export interface operations { name: string; /** * @description The target of the ruleset - * - * **Note**: The `push` target is in beta and is subject to change. + * @default branch * @enum {string} */ - target?: "branch" | "tag" | "push"; + target?: "branch" | "tag" | "push" | "repository"; enforcement: components["schemas"]["repository-rule-enforcement"]; /** @description The actors that can bypass the rules in this ruleset */ bypass_actors?: components["schemas"]["repository-ruleset-bypass-actor"][]; @@ -87688,6 +92418,7 @@ export interface operations { "repos/get-org-rule-suites": { parameters: { query?: { + ref?: components["parameters"]["ref-in-query"]; repository_name?: components["parameters"]["repository-name-in-query"]; time_period?: components["parameters"]["time-period"]; actor_name?: components["parameters"]["actor-name-in-query"]; @@ -87736,6 +92467,9 @@ export interface operations { /** * Get an organization repository ruleset * @description Get a repository ruleset for an organization. + * + * **Note:** To prevent leaking sensitive information, the `bypass_actors` property is only returned if the user + * making the API request has write access to the ruleset. */ "repos/get-org-ruleset": { parameters: { @@ -87776,11 +92510,9 @@ export interface operations { name?: string; /** * @description The target of the ruleset - * - * **Note**: The `push` target is in beta and is subject to change. * @enum {string} */ - target?: "branch" | "tag" | "push"; + target?: "branch" | "tag" | "push" | "repository"; enforcement?: components["schemas"]["repository-rule-enforcement"]; /** @description The actors that can bypass the rules in this ruleset */ bypass_actors?: components["schemas"]["repository-ruleset-bypass-actor"][]; @@ -87843,6 +92575,8 @@ export interface operations { before?: components["parameters"]["secret-scanning-pagination-before-org-repo"]; after?: components["parameters"]["secret-scanning-pagination-after-org-repo"]; validity?: components["parameters"]["secret-scanning-alert-validity"]; + is_publicly_leaked?: components["parameters"]["secret-scanning-alert-publicly-leaked"]; + is_multi_repo?: components["parameters"]["secret-scanning-alert-multi-repo"]; }; path: { org: components["parameters"]["org"]; @@ -87900,11 +92634,9 @@ export interface operations { }; /** * 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. + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** This operation is closing down and will be removed starting January 1, 2026. Please use the "[Organization Roles](https://docs.github.com/rest/orgs/organization-roles)" endpoints instead. */ "orgs/list-security-manager-teams": { parameters: { @@ -87923,11 +92655,9 @@ export interface operations { }; /** * 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. + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** This operation is closing down and will be removed starting January 1, 2026. Please use the "[Organization Roles](https://docs.github.com/rest/orgs/organization-roles)" endpoints instead. */ "orgs/add-security-manager-team": { parameters: { @@ -87941,19 +92671,13 @@ export interface operations { 204: { content: never; }; - /** @description The organization has reached the maximum number of security manager teams. */ - 409: { - 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. + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** This operation is closing down and will be removed starting January 1, 2026. Please use the "[Organization Roles](https://docs.github.com/rest/orgs/organization-roles)" endpoints instead. */ "orgs/remove-security-manager-team": { parameters: { @@ -88038,24 +92762,70 @@ export interface operations { }; }; }; + /** + * Get Copilot metrics for a team + * @description Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions. + * + * > [!NOTE] + * > This endpoint will only return results for a given day if the team had **five or more members with active Copilot licenses** on that day, as evaluated at the end of that day. + * + * The response contains metrics for up to 28 days prior. 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. + * + * To access this endpoint, the Copilot Metrics API access policy must be enabled for the organization containing the team within GitHub settings. + * Only organization owners for the organization that contains this team and owners and billing managers of the parent enterprise can view Copilot metrics for a team. + * + * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot`, `read:org`, or `read:enterprise` scopes to use this endpoint. + */ + "copilot/copilot-metrics-for-team": { + parameters: { + query?: { + /** @description Show usage metrics since this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). Maximum value is 28 days ago. */ + 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; + 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; + }; + path: { + org: components["parameters"]["org"]; + team_slug: components["parameters"]["team-slug"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["copilot-usage-metrics-day"][]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["usage_metrics_api_disabled"]; + 500: components["responses"]["internal_error"]; + }; + }; /** * Get a summary of Copilot usage for a team - * @description **Note**: This endpoint is in beta and is subject to change. + * @description > [!NOTE] + * > This endpoint is in public preview 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, + * The response contains metrics for up to 28 days prior. 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 with active Copilot licenses, as evaluated at the end of 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. + * Organization owners for the organization that contains this team, and owners and billing managers of the parent enterprise 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 either the `manage_billing:copilot`, `read:org`, or `read:enterprise` scopes to use this endpoint. */ "copilot/usage-metrics-for-team": { parameters: { @@ -88159,7 +92929,7 @@ export interface operations { | "notifications_enabled" | "notifications_disabled"; /** - * @description **Deprecated**. The permission that new repositories will be added to the team with when none is specified. + * @description **Closing down notice**. The permission that new repositories will be added to the team with when none is specified. * @default pull * @enum {string} */ @@ -88184,7 +92954,8 @@ export interface operations { * 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}`. */ "teams/get-by-name": { parameters: { @@ -88209,7 +92980,8 @@ export interface operations { * * 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}`. */ "teams/delete-in-org": { parameters: { @@ -88229,7 +93001,8 @@ export interface operations { * 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}`. */ "teams/update-in-org": { parameters: { @@ -88265,7 +93038,7 @@ export interface operations { | "notifications_enabled" | "notifications_disabled"; /** - * @description **Deprecated**. The permission that new repositories will be added to the team with when none is specified. + * @description **Closing down notice**. The permission that new repositories will be added to the team with when none is specified. * @default pull * @enum {string} */ @@ -88297,7 +93070,8 @@ export interface operations { * 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. */ @@ -88331,9 +93105,10 @@ 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)." + * 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/using-the-rest-api/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. */ @@ -88372,7 +93147,8 @@ export interface operations { * 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. */ @@ -88397,7 +93173,8 @@ export interface operations { * 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. */ @@ -88420,7 +93197,8 @@ export interface operations { * 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. */ @@ -88455,7 +93233,8 @@ export interface operations { * 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. */ @@ -88488,9 +93267,10 @@ 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)." + * 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/using-the-rest-api/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. */ @@ -88523,7 +93303,8 @@ export interface operations { * 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. */ @@ -88549,7 +93330,8 @@ export interface operations { * 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. */ @@ -88573,7 +93355,8 @@ export interface operations { * 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. */ @@ -88607,7 +93390,8 @@ export interface operations { * 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. */ @@ -88652,7 +93436,8 @@ export interface operations { * * 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. */ @@ -88701,7 +93486,8 @@ export interface operations { }; /** * 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`. + * @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). * @@ -88728,7 +93514,8 @@ export interface operations { * 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. */ @@ -88772,7 +93559,8 @@ export interface operations { * * 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. */ @@ -88820,7 +93608,8 @@ export interface operations { }; /** * 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`. + * @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). * @@ -88846,7 +93635,8 @@ export interface operations { * 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`. */ "teams/list-pending-invitations-in-org": { parameters: { @@ -88908,10 +93698,11 @@ export interface operations { * * 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). */ @@ -88942,13 +93733,15 @@ export interface operations { * * 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. * * 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}`. */ "teams/add-or-update-membership-for-user-in-org": { parameters: { @@ -88993,9 +93786,11 @@ export interface operations { * * 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}`. */ "teams/remove-membership-for-user-in-org": { parameters: { @@ -89020,7 +93815,8 @@ export interface operations { * 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`. */ "teams/list-projects-in-org": { parameters: { @@ -89049,7 +93845,8 @@ 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}`. + * > [!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: { @@ -89076,7 +93873,8 @@ export interface operations { * 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}`. */ "teams/add-or-update-project-permissions-in-org": { parameters: { @@ -89117,7 +93915,8 @@ 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}`. + * > [!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: { @@ -89138,7 +93937,8 @@ export interface operations { * 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`. */ "teams/list-repos-in-org": { parameters: { @@ -89167,13 +93967,14 @@ 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. + * 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/using-the-rest-api/getting-started-with-the-rest-api#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}`. + * > [!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: { @@ -89205,7 +94006,8 @@ export interface operations { * 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)". */ @@ -89221,10 +94023,7 @@ export interface operations { requestBody?: { content: { "application/json": { - /** - * @description The permission to grant the team on this repository. We accept the following permissions to be set: `pull`, `triage`, `push`, `maintain`, `admin` and you can also specify a custom repository role name, if the owning organization has defined any. If no permission is specified, the team's `permission` attribute will be used to determine what permission to grant the team on this repository. - * @default push - */ + /** @description The permission to grant the team on this repository. We accept the following permissions to be set: `pull`, `triage`, `push`, `maintain`, `admin` and you can also specify a custom repository role name, if the owning organization has defined any. If no permission is specified, the team's `permission` attribute will be used to determine what permission to grant the team on this repository. */ permission?: string; }; }; @@ -89240,7 +94039,8 @@ export interface operations { * 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}`. */ "teams/remove-repo-in-org": { parameters: { @@ -89262,7 +94062,8 @@ export interface operations { * 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`. */ "teams/list-child-in-org": { parameters: { @@ -89289,11 +94090,15 @@ 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)." + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** The ability to enable or disable a security feature for all eligible repositories in an organization is closing down. Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. For more information, see the [changelog](https://github.blog/changelog/2024-07-22-deprecation-of-api-endpoint-to-enable-or-disable-a-security-feature-for-an-organization/). + * + * 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. + * OAuth app tokens and personal access tokens (classic) need the `admin:org`, `write:org`, or `repo` scopes to use this endpoint. */ "orgs/enable-or-disable-security-product-on-all-org-repos": { parameters: { @@ -89983,7 +94788,8 @@ export interface operations { }; /** * Get rate limit status for the authenticated user - * @description **Note:** Accessing this endpoint does not count against your REST API rate limit. + * @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. @@ -89994,9 +94800,10 @@ export interface operations { * * 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)." + * * 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/about-the-rest-api/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 closing down. 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": { responses: { @@ -90019,7 +94826,8 @@ export interface operations { * 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)." */ "repos/get": { parameters: { @@ -90131,6 +94939,16 @@ export interface operations { /** @description Can be `enabled` or `disabled`. */ status?: string; }; + /** @description Use the `status` property to enable or disable secret scanning AI detection for this repository. For more information, see "[Responsible detection of generic secrets with AI](https://docs.github.com/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/generic-secret-detection/responsible-ai-generic-secrets)." */ + secret_scanning_ai_detection?: { + /** @description Can be `enabled` or `disabled`. */ + status?: string; + }; + /** @description Use the `status` property to enable or disable secret scanning non-provider patterns for this repository. For more information, see "[Supported secret scanning patterns](/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)." */ + secret_scanning_non_provider_patterns?: { + /** @description Can be `enabled` or `disabled`. */ + status?: string; + }; } | null; /** * @description Either `true` to enable issues for this repository or `false` to disable them. @@ -90186,12 +95004,14 @@ export interface operations { allow_update_branch?: boolean; /** * @deprecated - * @description Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @description Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message. **This property is closing down. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; /** - * @description The default value for a squash merge commit title: + * @description Required when using `squash_merge_commit_message`. + * + * The default value for a squash merge commit title: * * - `PR_TITLE` - default to the pull request's title. * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). @@ -90208,7 +95028,9 @@ export interface operations { */ squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** - * @description The default value for a merge commit title. + * @description Required when using `merge_commit_message`. + * + * The default value for a merge commit title. * * - `PR_TITLE` - default to the pull request's title. * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). @@ -91231,7 +96053,7 @@ export interface operations { * * 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 endpoint 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: { @@ -91526,8 +96348,8 @@ export interface operations { * 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. */ @@ -92276,6 +97098,8 @@ export interface operations { * 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 endpoint 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": { parameters: { @@ -92455,6 +97279,103 @@ export interface operations { }; }; }; + /** + * Create an attestation + * @description Store an artifact attestation and associate it with a repository. + * + * The authenticated user must have write permission to the repository and, if using a fine-grained access token, the `attestations:write` permission is required. + * + * Artifact attestations are meant to be created using the [attest action](https://github.com/actions/attest). For more information, see our guide on [using artifact attestations to establish a build's provenance](https://docs.github.com/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds). + */ + "repos/create-attestation": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + requestBody: { + content: { + "application/json": { + /** + * @description The attestation's Sigstore Bundle. + * Refer to the [Sigstore Bundle Specification](https://github.com/sigstore/protobuf-specs/blob/main/protos/sigstore_bundle.proto) for more information. + */ + bundle: { + mediaType?: string; + verificationMaterial?: { + [key: string]: unknown; + }; + dsseEnvelope?: { + [key: string]: unknown; + }; + }; + }; + }; + }; + responses: { + /** @description response */ + 201: { + content: { + "application/json": { + /** @description The ID of the attestation. */ + id?: number; + }; + }; + }; + 403: components["responses"]["forbidden"]; + 422: components["responses"]["validation_failed"]; + }; + }; + /** + * List attestations + * @description List a collection of artifact attestations with a given subject digest that are associated with a repository. + * + * The authenticated user making the request must have read access to the repository. In addition, when using a fine-grained access token the `attestations:read` permission is required. + * + * **Please note:** in order to offer meaningful security benefits, an attestation's signature and timestamps **must** be cryptographically verified, and the identity of the attestation signer **must** be validated. Attestations can be verified using the [GitHub CLI `attestation verify` command](https://cli.github.com/manual/gh_attestation_verify). For more information, see [our guide on how to use artifact attestations to establish a build's provenance](https://docs.github.com/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds). + */ + "repos/list-attestations": { + parameters: { + query?: { + per_page?: components["parameters"]["per-page"]; + before?: components["parameters"]["pagination-before"]; + after?: components["parameters"]["pagination-after"]; + }; + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** @description The parameter should be set to the attestation's subject's SHA256 digest, in the form `sha256:HEX_DIGEST`. */ + subject_digest: string; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": { + attestations?: { + /** + * @description The attestation's Sigstore Bundle. + * Refer to the [Sigstore Bundle Specification](https://github.com/sigstore/protobuf-specs/blob/main/protos/sigstore_bundle.proto) for more information. + */ + bundle?: { + mediaType?: string; + verificationMaterial?: { + [key: string]: unknown; + }; + dsseEnvelope?: { + [key: string]: unknown; + }; + }; + repository_id?: number; + bundle_url?: string; + }[]; + }; + }; + }; + }; + }; /** * Get all autolinks of a repository * @description Gets all autolinks that are configured for a repository. @@ -92575,13 +97496,13 @@ export interface operations { }; }; responses: { - /** @description Response if dependabot is enabled */ + /** @description Response if Dependabot is enabled */ 200: { content: { "application/json": components["schemas"]["check-automated-security-fixes"]; }; }; - /** @description Not Found if dependabot is not enabled for the repository */ + /** @description Not Found if Dependabot is not enabled for the repository */ 404: { content: never; }; @@ -92627,7 +97548,7 @@ export interface operations { "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. */ + /** @description Setting to `true` returns only branches protected by branch protections or rulesets. When set to `false`, only unprotected branches are returned. Omitting this parameter returns all branches. */ protected?: boolean; per_page?: components["parameters"]["per-page"]; page?: components["parameters"]["page"]; @@ -92698,9 +97619,11 @@ export interface operations { * * 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. */ "repos/update-branch-protection": { parameters: { @@ -92719,7 +97642,7 @@ export interface operations { strict: boolean; /** * @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. + * @description **Closing down notice**: 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. */ @@ -92941,7 +97864,8 @@ export interface operations { * * 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. */ "repos/update-pull-request-review-protection": { parameters: { @@ -93002,7 +97926,8 @@ export interface operations { * * 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. */ "repos/get-commit-signature-protection": { parameters: { @@ -93130,7 +98055,7 @@ export interface operations { strict?: boolean; /** * @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. + * @description **Closing down notice**: 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. */ @@ -93276,7 +98201,8 @@ export interface operations { * * 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. */ "repos/get-access-restrictions": { parameters: { @@ -93355,7 +98281,7 @@ export interface operations { branch: components["parameters"]["branch"]; }; }; - requestBody?: { + requestBody: { content: { "application/json": { /** @description The GitHub Apps that have push access to this branch. Use the slugified version of the app name. **Note**: The list of users, apps, and teams in total is limited to 100 items. */ @@ -93387,7 +98313,7 @@ export interface operations { branch: components["parameters"]["branch"]; }; }; - requestBody?: { + requestBody: { content: { "application/json": { /** @description The GitHub Apps that have push access to this branch. Use the slugified version of the app name. **Note**: The list of users, apps, and teams in total is limited to 100 items. */ @@ -93419,7 +98345,7 @@ export interface operations { branch: components["parameters"]["branch"]; }; }; - requestBody?: { + requestBody: { content: { "application/json": { /** @description The GitHub Apps that have push access to this branch. Use the slugified version of the app name. **Note**: The list of users, apps, and teams in total is limited to 100 items. */ @@ -93599,7 +98525,7 @@ export interface operations { branch: components["parameters"]["branch"]; }; }; - requestBody?: { + requestBody: { content: { "application/json": { /** @description The username for users */ @@ -93635,7 +98561,7 @@ export interface operations { branch: components["parameters"]["branch"]; }; }; - requestBody?: { + requestBody: { content: { "application/json": { /** @description The username for users */ @@ -93671,7 +98597,7 @@ export interface operations { branch: components["parameters"]["branch"]; }; }; - requestBody?: { + requestBody: { content: { "application/json": { /** @description The username for users */ @@ -93693,7 +98619,8 @@ export interface operations { * 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. * @@ -93850,7 +98777,8 @@ export interface operations { * 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. */ @@ -93875,7 +98803,8 @@ export interface operations { * 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. */ @@ -94077,7 +99006,8 @@ export interface operations { * 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. */ @@ -94152,7 +99082,8 @@ export interface operations { * 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. */ @@ -94177,7 +99108,8 @@ export interface operations { * 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. */ @@ -94341,6 +99273,112 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; + /** + * Get the status of an autofix for a code scanning alert + * @description Gets the status and description of an autofix for a 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-autofix": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + alert_number: components["parameters"]["alert-number"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["code-scanning-autofix"]; + }; + }; + 400: components["responses"]["code_scanning_bad_request"]; + 403: components["responses"]["code_scanning_forbidden_read"]; + 404: components["responses"]["not_found"]; + 503: components["responses"]["service_unavailable"]; + }; + }; + /** + * Create an autofix for a code scanning alert + * @description Creates an autofix for a code scanning alert. + * + * If a new autofix is to be created as a result of this request or is currently being generated, then this endpoint will return a 202 Accepted response. + * + * If an autofix already exists for a given alert, then this endpoint will return a 200 OK response. + * + * 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/create-autofix": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + alert_number: components["parameters"]["alert-number"]; + }; + }; + responses: { + /** @description OK */ + 200: { + content: { + "application/json": components["schemas"]["code-scanning-autofix"]; + }; + }; + /** @description Accepted */ + 202: { + content: { + "application/json": components["schemas"]["code-scanning-autofix"]; + }; + }; + 400: components["responses"]["code_scanning_bad_request"]; + 403: components["responses"]["code_scanning_autofix_create_forbidden"]; + 404: components["responses"]["not_found"]; + /** @description Unprocessable Entity */ + 422: { + content: never; + }; + 503: components["responses"]["service_unavailable"]; + }; + }; + /** + * Commit an autofix for a code scanning alert + * @description Commits an autofix for a code scanning alert. + * + * If an autofix is commited as a result of this request, then this endpoint will return a 201 Created response. + * + * 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/commit-autofix": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + alert_number: components["parameters"]["alert-number"]; + }; + }; + requestBody?: { + content: { + "application/json": components["schemas"]["code-scanning-autofix-commits"]; + }; + }; + responses: { + /** @description Created */ + 201: { + content: { + "application/json": components["schemas"]["code-scanning-autofix-commits-response"]; + }; + }; + 400: components["responses"]["code_scanning_bad_request"]; + 403: components["responses"]["code_scanning_forbidden_write"]; + 404: components["responses"]["not_found"]; + /** @description Unprocessable Entity */ + 422: { + content: never; + }; + 503: components["responses"]["service_unavailable"]; + }; + }; /** * List instances of a code scanning alert * @description Lists all instances of the specified code scanning alert. @@ -94353,6 +99391,7 @@ export interface operations { page?: components["parameters"]["page"]; per_page?: components["parameters"]["per-page"]; ref?: components["parameters"]["git-ref"]; + pr?: components["parameters"]["pr-alias"]; }; path: { owner: components["parameters"]["owner"]; @@ -94385,8 +99424,8 @@ export interface operations { * 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. + * > [!WARNING] + * > **Closing down notice:** The `tool_name` field is closing down 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. */ @@ -94397,6 +99436,7 @@ export interface operations { tool_guid?: components["parameters"]["tool-guid"]; page?: components["parameters"]["page"]; per_page?: components["parameters"]["per-page"]; + pr?: components["parameters"]["pr-alias"]; /** @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. */ @@ -94563,7 +99603,7 @@ export interface operations { * 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 `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/list-codeql-databases": { parameters: { @@ -94590,11 +99630,11 @@ export interface operations { * * 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 + * to [`application/zip`](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#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 `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-codeql-database": { parameters: { @@ -94618,6 +99658,138 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; + /** + * Delete a CodeQL database + * @description Deletes a CodeQL database for a language in a repository. + * + * 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-codeql-database": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** @description The language of the CodeQL database. */ + language: string; + }; + }; + responses: { + /** @description Response */ + 204: { + content: never; + }; + 403: components["responses"]["code_scanning_forbidden_write"]; + 404: components["responses"]["not_found"]; + 503: components["responses"]["service_unavailable"]; + }; + }; + /** + * Create a CodeQL variant analysis + * @description Creates a new CodeQL variant analysis, which will run a CodeQL query against one or more repositories. + * + * Get started by learning more about [running CodeQL queries at scale with Multi-Repository Variant Analysis](https://docs.github.com/code-security/codeql-for-vs-code/getting-started-with-codeql-for-vs-code/running-codeql-queries-at-scale-with-multi-repository-variant-analysis). + * + * Use the `owner` and `repo` parameters in the URL to specify the controller repository that + * will be used for running GitHub Actions workflows and storing the results of the CodeQL variant analysis. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + "code-scanning/create-variant-analysis": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + requestBody: { + content: { + "application/json": { + language: components["schemas"]["code-scanning-variant-analysis-language"]; + /** @description A Base64-encoded tarball containing a CodeQL query and all its dependencies */ + query_pack: string; + /** @description List of repository names (in the form `owner/repo-name`) to run the query against. Precisely one property from `repositories`, `repository_lists` and `repository_owners` is required. */ + repositories?: string[]; + /** @description List of repository lists to run the query against. Precisely one property from `repositories`, `repository_lists` and `repository_owners` is required. */ + repository_lists?: string[]; + /** @description List of organization or user names whose repositories the query should be run against. Precisely one property from `repositories`, `repository_lists` and `repository_owners` is required. */ + repository_owners?: string[]; + }; + }; + }; + responses: { + /** @description Variant analysis submitted for processing */ + 201: { + content: { + "application/json": components["schemas"]["code-scanning-variant-analysis"]; + }; + }; + 404: components["responses"]["not_found"]; + /** @description Unable to process variant analysis submission */ + 422: { + content: { + "application/json": components["schemas"]["basic-error"]; + }; + }; + 503: components["responses"]["service_unavailable"]; + }; + }; + /** + * Get the summary of a CodeQL variant analysis + * @description Gets the summary of a CodeQL variant analysis. + * + * 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-variant-analysis": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + /** @description The unique identifier of the variant analysis. */ + codeql_variant_analysis_id: number; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["code-scanning-variant-analysis"]; + }; + }; + 404: components["responses"]["not_found"]; + 503: components["responses"]["service_unavailable"]; + }; + }; + /** + * Get the analysis status of a repository in a CodeQL variant analysis + * @description Gets the analysis status of a repository in a CodeQL variant analysis. + * + * 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-variant-analysis-repo-task": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + /** @description The name of the controller repository. */ + repo: string; + /** @description The ID of the variant analysis. */ + codeql_variant_analysis_id: number; + /** @description The account owner of the variant analysis repository. The name is not case sensitive. */ + repo_owner: string; + /** @description The name of the variant analysis repository. */ + repo_name: string; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["code-scanning-variant-analysis-repo-task"]; + }; + }; + 404: components["responses"]["not_found"]; + 503: components["responses"]["service_unavailable"]; + }; + }; /** * Get a code scanning default setup configuration * @description Gets a code scanning default setup configuration. @@ -94714,6 +99886,8 @@ export interface operations { * 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. + * + * This endpoint is limited to 1,000 requests per hour for each user or app installation calling it. */ "code-scanning/upload-sarif": { parameters: { @@ -94799,6 +99973,34 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; + /** + * Get the code security configuration associated with a repository + * @description Get the code security configuration that manages a repository's code security settings. + * + * 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` scope to use this endpoint. + */ + "code-security/get-configuration-for-repository": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["code-security-configuration-for-repository"]; + }; + }; + 204: components["responses"]["no_content"]; + 304: components["responses"]["not_modified"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; /** * List CODEOWNERS errors * @description List any syntax errors that are detected in the CODEOWNERS @@ -94885,7 +100087,7 @@ export interface operations { /** @description The requested location for a new codespace. Best efforts are made to respect this upon creation. Assigned by IP if not provided. */ location?: string; /** - * @description The geographic area for this codespace. If not specified, the value is assigned by IP. This property replaces `location`, which is being deprecated. + * @description The geographic area for this codespace. If not specified, the value is assigned by IP. This property replaces `location`, which is closing down. * @enum {string} */ geo?: "EuropeWest" | "SoutheastAsia" | "UsEast" | "UsWest"; @@ -95113,8 +100315,6 @@ export interface operations { * @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": { @@ -95285,7 +100485,7 @@ export interface operations { }; /** * 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)." + * @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/using-the-rest-api/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)." * @@ -95364,7 +100564,8 @@ export interface operations { * - 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. * @@ -95620,7 +100821,8 @@ export interface operations { }; /** * 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`. + * @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). */ @@ -95652,6 +100854,7 @@ export interface operations { * | `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. | + * | `verified_at` | `string` | The date the signature was verified by GitHub. | * * These are the possible values for `reason` in the `verification` object: * @@ -95682,8 +100885,9 @@ export interface operations { author?: string; /** @description GitHub username or email address to use to filter by commit committer. */ committer?: string; - 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`. */ + /** @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`. Due to limitations of Git, timestamps must be between 1970-01-01 and 2099-12-31 (inclusive) or unexpected results may be returned. */ + since?: string; + /** @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`. Due to limitations of Git, timestamps must be between 1970-01-01 and 2099-12-31 (inclusive) or unexpected results may be returned. */ until?: string; per_page?: components["parameters"]["per-page"]; page?: components["parameters"]["page"]; @@ -95773,7 +100977,7 @@ 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 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/using-the-rest-api/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)." * @@ -95799,7 +101003,7 @@ export interface operations { path?: string; /** @description Line index in the diff to comment on. */ position?: number; - /** @description **Deprecated**. Use **position** parameter instead. Line number in the file to comment on. */ + /** @description **Closing down notice**. Use **position** parameter instead. Line number in the file to comment on. */ line?: number; }; }; @@ -95854,7 +101058,8 @@ 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 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. * @@ -95872,6 +101077,7 @@ export interface operations { * | `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. | + * | `verified_at` | `string` | The date the signature was verified by GitHub. | * * These are the possible values for `reason` in the `verification` object: * @@ -95921,7 +101127,8 @@ export interface operations { * 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. * @@ -95963,7 +101170,8 @@ 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`. + * > [!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. */ @@ -96113,7 +101321,7 @@ export interface operations { * * 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 list of changed files is only shown on the first page of results, and it includes up to 300 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)." @@ -96128,6 +101336,7 @@ export interface operations { * | `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. | + * | `verified_at` | `string` | The date the signature was verified by GitHub. | * * These are the possible values for `reason` in the `verification` object: * @@ -96226,6 +101435,7 @@ export interface operations { }; }; 302: components["responses"]["found"]; + 304: components["responses"]["not_modified"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; }; @@ -96234,7 +101444,8 @@ export interface operations { * 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. */ @@ -96293,7 +101504,14 @@ export interface operations { }; }; 404: components["responses"]["not_found"]; - 409: components["responses"]["conflict"]; + /** @description Conflict */ + 409: { + content: { + "application/json": + | components["schemas"]["basic-error"] + | components["schemas"]["repository-rule-violation-error"]; + }; + }; 422: components["responses"]["validation_failed"]; }; }; @@ -96307,7 +101525,8 @@ export interface operations { * * 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. */ "repos/delete-file": { parameters: { @@ -96411,7 +101630,7 @@ export interface operations { direction?: components["parameters"]["direction"]; /** * @deprecated - * @description **Deprecated**. Page number of the results to fetch. Use cursor-based pagination with `before` or `after` instead. + * @description **Closing down notice**. Page number of the results to fetch. Use cursor-based pagination with `before` or `after` instead. */ page?: number; /** @@ -97019,7 +102238,10 @@ export interface operations { | "pending" | "success"; /** - * @description The target URL to associate with this status. This URL should contain output to keep the user updated while the task is running or serve as historical information for what happened in the deployment. **Note:** It's recommended to use the `log_url` parameter, which replaces `target_url`. + * @description The target URL to associate with this status. This URL should contain output to keep the user updated while the task is running or serve as historical information for what happened in the deployment. + * + * > [!NOTE] + * > It's recommended to use the `log_url` parameter, which replaces `target_url`. * @default */ target_url?: string; @@ -97104,7 +102326,7 @@ export interface operations { "application/json": { /** @description A custom webhook event name. Must be 100 characters or fewer. */ event_type: string; - /** @description JSON payload with extra information about the webhook event that your action or workflow may use. The maximum number of top-level properties is 10. */ + /** @description JSON payload with extra information about the webhook event that your action or workflow may use. The maximum number of top-level properties is 10. The total size of the JSON payload must be less than 64KB. */ client_payload?: { [key: string]: unknown; }; @@ -97157,7 +102379,8 @@ 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)." + * @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. * @@ -97184,9 +102407,11 @@ export interface operations { * 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. */ @@ -97470,7 +102695,9 @@ export interface operations { }; /** * 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. + * @description Gets all custom deployment protection rule integrations that are available for an environment. + * + * The authenticated user must have admin or owner permissions to the repository to 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)." * @@ -97865,7 +103092,8 @@ export interface operations { }; /** * 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. + * @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: { @@ -97918,9 +103146,11 @@ export interface operations { * 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. */ "repos/create-fork": { parameters: { @@ -97989,7 +103219,14 @@ export interface operations { 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; 409: components["responses"]["conflict"]; - 422: components["responses"]["validation_failed"]; + /** @description Validation failed */ + 422: { + content: { + "application/json": + | components["schemas"]["validation-error"] + | components["schemas"]["repository-rule-violation-error"]; + }; + }; }; }; /** @@ -98038,6 +103275,7 @@ export interface operations { * | `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. | + * | `verified_at` | `string` | The date the signature was verified by GitHub. | * * These are the possible values for `reason` in the `verification` object: * @@ -98071,7 +103309,7 @@ export interface operations { message: string; /** @description The SHA of the tree object this commit points to */ tree: string; - /** @description The SHAs of the commits that were the parents of this commit. If omitted or empty, the commit will be written as a root commit. For a single parent, an array of one SHA should be provided; for a merge commit, an array of more than one should be provided. */ + /** @description The full SHAs of the commits that were the parents of this commit. If omitted or empty, the commit will be written as a root commit. For a single parent, an array of one SHA should be provided; for a merge commit, an array of more than one should be provided. */ parents?: string[]; /** @description Information about the author of the commit. By default, the `author` will be the authenticated user and the current date. See the `author` and `committer` object below for details. */ author?: { @@ -98134,6 +103372,7 @@ export interface operations { * | `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. | + * | `verified_at` | `string` | The date the signature was verified by GitHub. | * * These are the possible values for `reason` in the `verification` object: * @@ -98178,7 +103417,8 @@ export interface operations { * * 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`. */ @@ -98207,7 +103447,8 @@ 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/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)". */ "git/get-ref": { parameters: { @@ -98335,6 +103576,7 @@ export interface operations { * | `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. | + * | `verified_at` | `string` | The date the signature was verified by GitHub. | * * These are the possible values for `reason` in the `verification` object: * @@ -98417,6 +103659,7 @@ export interface operations { * | `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. | + * | `verified_at` | `string` | The date the signature was verified by GitHub. | * * These are the possible values for `reason` in the `verification` object: * @@ -98531,8 +103774,8 @@ export interface operations { * * 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. */ "git/get-tree": { parameters: { @@ -98664,7 +103907,12 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** Delete a repository webhook */ + /** + * Delete a repository webhook + * @description Delete a webhook for an organization. + * + * The authenticated user must be a repository owner, or have admin access in the repository, to delete the webhook. + */ "repos/delete-webhook": { parameters: { path: { @@ -98792,7 +104040,6 @@ export interface operations { query?: { per_page?: components["parameters"]["per-page"]; cursor?: components["parameters"]["cursor"]; - redelivery?: boolean; }; path: { owner: components["parameters"]["owner"]; @@ -98878,7 +104125,8 @@ export interface operations { * 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` */ "repos/test-push-webhook": { parameters: { @@ -98901,7 +104149,8 @@ export interface operations { * @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] + * > **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down 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** * @@ -98961,7 +104210,8 @@ export interface operations { * 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] + * > **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down 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: { @@ -99010,7 +104260,8 @@ export interface operations { * @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] + * > **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down 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: { @@ -99037,7 +104288,8 @@ export interface operations { * 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] + * > **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down 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: { @@ -99084,7 +104336,8 @@ export interface operations { * * 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] + * > **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down 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: { @@ -99113,7 +104366,8 @@ export interface operations { * @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). + * > [!WARNING] + * > **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down 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: { @@ -99150,7 +104404,8 @@ export interface operations { * @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] + * > **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down 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: { @@ -99178,7 +104433,8 @@ export interface operations { * 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] + * > **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down 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: { @@ -99382,10 +104638,8 @@ export interface operations { * 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)." * @@ -99439,7 +104693,7 @@ export interface operations { * 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)" + * 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/using-the-rest-api/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)." @@ -99463,7 +104717,7 @@ export interface operations { title: string | number; /** @description The contents of the issue. */ 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.**_ */ + /** @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 closing down.**_ */ assignee?: string | 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._ */ @@ -99717,7 +104971,8 @@ export interface operations { }; /** * 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`. + * @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). */ @@ -99798,10 +105053,8 @@ export interface operations { * 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)." * @@ -99833,7 +105086,7 @@ export interface operations { }; /** * Update an issue - * @description Issue owners and users with push access can edit an issue. + * @description Issue owners and users with push access or Triage role 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)." * @@ -99857,7 +105110,7 @@ export interface operations { title?: string | number | null; /** @description The contents of the issue. */ body?: string | null; - /** @description Username to assign to this issue. **This field is deprecated.** */ + /** @description Username to assign to this issue. **This field is closing down.** */ assignee?: string | null; /** * @description The open or closed state of the issue. @@ -100037,7 +105290,7 @@ export interface operations { * * 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)" + * For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/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)." @@ -100421,7 +105674,8 @@ export interface operations { }; /** * 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`. + * @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). */ @@ -100441,6 +105695,173 @@ export interface operations { }; }; }; + /** + * Remove sub-issue + * @description You can use the REST API to remove a sub-issue from an issue. + * Removing 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/using-the-rest-api/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 a specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response 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/remove-sub-issue": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + issue_number: components["parameters"]["issue-number"]; + }; + }; + requestBody: { + content: { + "application/json": { + /** @description The sub-issue to remove */ + sub_issue_id: number; + }; + }; + }; + responses: { + /** @description Response */ + 200: { + headers: { + /** @example https://api.github.com/repos/octocat/Hello-World/issues/1/sub-issue */ + Location?: string; + }; + content: { + "application/json": components["schemas"]["issue"]; + }; + }; + 400: components["responses"]["bad_request"]; + 404: components["responses"]["not_found"]; + }; + }; + /** + * List sub-issues + * @description You can use the REST API to list the sub-issues on 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/list-sub-issues": { + parameters: { + query?: { + per_page?: components["parameters"]["per-page"]; + page?: components["parameters"]["page"]; + }; + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + issue_number: components["parameters"]["issue-number"]; + }; + }; + responses: { + /** @description Response */ + 200: { + headers: { + Link: components["headers"]["link"]; + }; + content: { + "application/json": components["schemas"]["issue"][]; + }; + }; + 404: components["responses"]["not_found"]; + 410: components["responses"]["gone"]; + }; + }; + /** + * Add sub-issue + * @description You can use the REST API to add sub-issues to issues. + * + * 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/using-the-rest-api/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/add-sub-issue": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + issue_number: components["parameters"]["issue-number"]; + }; + }; + requestBody: { + content: { + "application/json": { + /** @description The sub-issue to add */ + sub_issue_id: number; + /** @description Option that, when true, instructs the operation to replace the sub-issues current parent issue */ + replace_parent?: boolean; + }; + }; + }; + responses: { + /** @description Response */ + 201: { + headers: { + /** @example https://api.github.com/repos/octocat/Hello-World/issues/sub-issues/1 */ + Location?: string; + }; + content: { + "application/json": components["schemas"]["issue"]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 410: components["responses"]["gone"]; + 422: components["responses"]["validation_failed"]; + }; + }; + /** + * Reprioritize sub-issue + * @description You can use the REST API to reprioritize a sub-issue to a different position in the parent list. + */ + "issues/reprioritize-sub-issue": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + issue_number: components["parameters"]["issue-number"]; + }; + }; + requestBody: { + content: { + "application/json": { + /** @description The id of the sub-issue to reprioritize */ + sub_issue_id: number; + /** @description The id of the sub-issue to be prioritized after (either positional argument after OR before should be specified). */ + after_id?: number; + /** @description The id of the sub-issue to be prioritized before (either positional argument after OR before should be specified). */ + before_id?: number; + }; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["issue"]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed_simple"]; + 503: components["responses"]["service_unavailable"]; + }; + }; /** * List timeline events for an issue * @description List all timeline events for an issue. @@ -101142,7 +106563,7 @@ export interface operations { 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/)." */ + /** @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/pages/configuring-a-custom-domain-for-your-github-pages-site)." */ cname?: string | null; /** @description Specify whether HTTPS should be enforced for the repository. */ https_enforced?: boolean; @@ -101713,7 +107134,7 @@ export interface operations { * * 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/using-the-rest-api/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)." * @@ -101986,7 +107407,8 @@ export interface operations { }; /** * 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.` + * @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). */ @@ -102022,7 +107444,7 @@ export interface operations { * * 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/using-the-rest-api/getting-started-with-the-rest-api#media-types) 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)." * @@ -102041,7 +107463,7 @@ export interface operations { }; }; 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. */ + /** @description Pass the appropriate [media type](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types) to fetch diff and patch formats. */ 200: { content: { "application/json": components["schemas"]["pull-request"]; @@ -102125,7 +107547,7 @@ export interface operations { /** @description The requested location for a new codespace. Best efforts are made to respect this upon creation. Assigned by IP if not provided. */ location?: string; /** - * @description The geographic area for this codespace. If not specified, the value is assigned by IP. This property replaces `location`, which is being deprecated. + * @description The geographic area for this codespace. If not specified, the value is assigned by IP. This property replaces `location`, which is closing down. * @enum {string} */ geo?: "EuropeWest" | "SoutheastAsia" | "UsEast" | "UsWest"; @@ -102213,9 +107635,9 @@ export interface operations { * * 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 closing down. 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)" + * 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/using-the-rest-api/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)." @@ -102244,7 +107666,7 @@ export interface operations { path: string; /** * @deprecated - * @description **This parameter is deprecated. Use `line` instead**. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the 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. + * @description **This parameter is closing down. Use `line` instead**. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the 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. */ position?: number; /** @@ -102293,7 +107715,7 @@ export interface operations { * 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)" + * 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/using-the-rest-api/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)." @@ -102375,8 +107797,8 @@ 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. + * > [!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)." * @@ -102438,7 +107860,7 @@ export interface operations { /** * 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/using-the-rest-api/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: { @@ -102626,11 +108048,12 @@ 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)." + * 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/using-the-rest-api/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. + * > [!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. * @@ -102832,9 +108255,8 @@ export interface operations { * 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)." * @@ -102924,6 +108346,7 @@ export interface operations { /** * 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. + * Note: If making a request on behalf of a GitHub App you must also have permissions to write the contents of the head repository. */ "pulls/update-branch": { parameters: { @@ -102982,6 +108405,7 @@ export interface operations { "application/json": components["schemas"]["content-file"]; }; }; + 304: components["responses"]["not_modified"]; 404: components["responses"]["not_found"]; 422: components["responses"]["validation_failed"]; }; @@ -103053,7 +108477,7 @@ export interface operations { * 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/using-the-rest-api/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: { @@ -103121,7 +108545,13 @@ export interface operations { }; /** * 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. + * @description To download the asset's binary content: + * + * - If within a browser, fetch the location specified in the `browser_download_url` key provided in the response. + * - Alternatively, set the `Accept` header of the request to + * [`application/octet-stream`](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#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: { @@ -103275,9 +108705,8 @@ export interface operations { * 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)." */ "repos/get-release": { parameters: { @@ -103521,7 +108950,8 @@ export interface operations { }; /** * 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`. + * @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). */ @@ -103580,6 +109010,7 @@ export interface operations { page?: components["parameters"]["page"]; /** @description Include rulesets configured at higher levels that apply to this repository */ includes_parents?: boolean; + targets?: components["parameters"]["ruleset-targets"]; }; path: { owner: components["parameters"]["owner"]; @@ -103616,8 +109047,7 @@ export interface operations { name: string; /** * @description The target of the ruleset - * - * **Note**: The `push` target is in beta and is subject to change. + * @default branch * @enum {string} */ target?: "branch" | "tag" | "push"; @@ -103699,6 +109129,9 @@ export interface operations { /** * Get a repository ruleset * @description Get a ruleset for a repository. + * + * **Note:** To prevent leaking sensitive information, the `bypass_actors` property is only returned if the user + * making the API request has write access to the ruleset. */ "repos/get-repo-ruleset": { parameters: { @@ -103745,8 +109178,6 @@ export interface operations { name?: string; /** * @description The target of the ruleset - * - * **Note**: The `push` target is in beta and is subject to change. * @enum {string} */ target?: "branch" | "tag" | "push"; @@ -103813,6 +109244,8 @@ export interface operations { before?: components["parameters"]["secret-scanning-pagination-before-org-repo"]; after?: components["parameters"]["secret-scanning-pagination-after-org-repo"]; validity?: components["parameters"]["secret-scanning-alert-validity"]; + is_publicly_leaked?: components["parameters"]["secret-scanning-alert-publicly-leaked"]; + is_multi_repo?: components["parameters"]["secret-scanning-alert-multi-repo"]; }; path: { owner: components["parameters"]["owner"]; @@ -103948,6 +109381,78 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; + /** + * Create a push protection bypass + * @description Creates a bypass for a previously push protected secret. + * + * The authenticated user must be the original author of the committed secret. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + "secret-scanning/create-push-protection-bypass": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + requestBody: { + content: { + "application/json": { + reason: components["schemas"]["secret-scanning-push-protection-bypass-reason"]; + placeholder_id: components["schemas"]["secret-scanning-push-protection-bypass-placeholder-id"]; + }; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["secret-scanning-push-protection-bypass"]; + }; + }; + /** @description User does not have enough permissions to perform this action. */ + 403: { + content: never; + }; + /** @description Placeholder ID not found, or push protection is disabled on this repository. */ + 404: { + content: never; + }; + /** @description Bad request, input data missing or incorrect. */ + 422: { + content: never; + }; + 503: components["responses"]["service_unavailable"]; + }; + }; + /** + * Get secret scanning scan history for a repository + * @description Lists the latest default incremental and backfill scans by type for a repository. Scans from Copilot Secret Scanning are not included. + * + * 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-scan-history": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["secret-scanning-scan-history"]; + }; + }; + /** @description Repository does not have GitHub Advanced Security or secret scanning enabled */ + 404: { + content: never; + }; + 503: components["responses"]["service_unavailable"]; + }; + }; /** * List repository security advisories * @description Lists security advisories in a repository. @@ -104145,7 +109650,8 @@ export interface operations { * 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. */ "security-advisories/create-fork": { parameters: { @@ -104204,11 +109710,10 @@ export interface operations { }; /** * Get the weekly commit activity - * @description - * Returns a weekly aggregate of the number of additions and deletions pushed to a repository. + * @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. + * > [!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: { @@ -104264,7 +109769,8 @@ export interface operations { * * `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. */ "repos/get-contributors-stats": { parameters: { @@ -104512,8 +110018,12 @@ export interface operations { }; }; /** - * List tag protection states for a repository - * @description This returns the tag protection states of a repository. + * Closing down - List tag protection states for a repository + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** This operation is closing down and will be removed after August 30, 2024. Use the "[Repository Rulesets](https://docs.github.com/rest/repos/rules#get-all-repository-rulesets)" endpoint instead. + * + * This returns the tag protection states of a repository. * * This information is only available to repository administrators. */ @@ -104536,8 +110046,12 @@ export interface operations { }; }; /** - * Create a tag protection state for a repository - * @description This creates a tag protection state for a repository. + * Closing down - Create a tag protection state for a repository + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** This operation is closing down and will be removed after August 30, 2024. Use the "[Repository Rulesets](https://docs.github.com/rest/repos/rules#create-a-repository-ruleset)" endpoint instead. + * + * This creates a tag protection state for a repository. * This endpoint is only available to repository administrators. */ "repos/create-tag-protection": { @@ -104567,8 +110081,12 @@ export interface operations { }; }; /** - * Delete a tag protection state for a repository - * @description This deletes a tag protection state for a repository. + * Closing down - Delete a tag protection state for a repository + * @deprecated + * @description > [!WARNING] + * > **Closing down notice:** This operation is closing down and will be removed after August 30, 2024. Use the "[Repository Rulesets](https://docs.github.com/rest/repos/rules#delete-a-repository-ruleset)" endpoint instead. + * + * This deletes a tag protection state for a repository. * This endpoint is only available to repository administrators. */ "repos/delete-tag-protection": { @@ -104593,7 +110111,9 @@ export interface operations { * @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. + * + * > [!NOTE] + * > For private repositories, these links are temporary and expire after five minutes. */ "repos/download-tarball-archive": { parameters: { @@ -104679,7 +110199,7 @@ export interface operations { requestBody: { content: { "application/json": { - /** @description An array of topics to add to the repository. Pass one or more topics to _replace_ the set of existing topics. Send an empty array (`[]`) to clear all topics from the repository. **Note:** Topic `names` cannot contain uppercase letters. */ + /** @description An array of topics to add to the repository. Pass one or more topics to _replace_ the set of existing topics. Send an empty array (`[]`) to clear all topics from the repository. **Note:** Topic `names` will be saved as lowercase. */ names: string[]; }; }; @@ -104883,7 +110403,8 @@ export interface operations { * `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. */ "repos/download-zipball-archive": { parameters: { @@ -105013,12 +110534,12 @@ export interface operations { q: string; /** * @deprecated - * @description **This field is deprecated.** Sorts the results of your query. Can only be `indexed`, which indicates how recently a file has been indexed by the GitHub search infrastructure. Default: [best match](https://docs.github.com/rest/search/search#ranking-search-results) + * @description **This field is closing down.** Sorts the results of your query. Can only be `indexed`, which indicates how recently a file has been indexed by the GitHub search infrastructure. Default: [best match](https://docs.github.com/rest/search/search#ranking-search-results) */ sort?: "indexed"; /** * @deprecated - * @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`. + * @description **This field is closing down.** 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"; per_page?: components["parameters"]["per-page"]; @@ -105092,7 +110613,8 @@ export interface operations { * * 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)." */ "search/issues-and-pull-requests": { parameters: { @@ -105297,7 +110819,8 @@ export interface operations { /** * 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. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down 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: { @@ -105318,7 +110841,8 @@ export interface operations { /** * 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. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down 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. * @@ -105342,11 +110866,13 @@ export interface operations { /** * 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. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down 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`. + * > [!NOTE] + * > With nested teams, the `privacy` for parent teams cannot be `secret`. */ "teams/update-legacy": { parameters: { @@ -105381,7 +110907,7 @@ export interface operations { | "notifications_enabled" | "notifications_disabled"; /** - * @description **Deprecated**. The permission that new repositories will be added to the team with when none is specified. + * @description **Closing down notice**. The permission that new repositories will be added to the team with when none is specified. * @default pull * @enum {string} */ @@ -105412,7 +110938,8 @@ export interface operations { /** * 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. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down 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. * @@ -105444,11 +110971,12 @@ 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. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down 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)." + * 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/using-the-rest-api/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. */ @@ -105485,7 +111013,8 @@ export interface operations { /** * 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. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down 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. * @@ -105510,7 +111039,8 @@ export interface operations { /** * 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. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down 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. * @@ -105533,7 +111063,8 @@ export interface operations { /** * 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. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down 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. * @@ -105568,7 +111099,8 @@ export interface operations { /** * 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. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down 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. * @@ -105601,11 +111133,12 @@ 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. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down 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)." + * 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/using-the-rest-api/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. */ @@ -105636,7 +111169,8 @@ export interface operations { /** * 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. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down 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. * @@ -105662,7 +111196,8 @@ export interface operations { /** * 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. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down 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. * @@ -105686,7 +111221,8 @@ export interface operations { /** * 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. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down 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. * @@ -105720,7 +111256,8 @@ export interface operations { /** * 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. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down 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). * @@ -105763,7 +111300,8 @@ 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. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down 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). * @@ -105810,7 +111348,8 @@ export interface operations { /** * 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. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down 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). * @@ -105852,7 +111391,8 @@ 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. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down 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). * @@ -105898,7 +111438,8 @@ export interface operations { /** * 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. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down 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`. */ @@ -105927,7 +111468,8 @@ 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. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down 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. */ @@ -105959,7 +111501,7 @@ export interface operations { /** * Get team member (Legacy) * @deprecated - * @description The "Get team member" endpoint (described below) is deprecated. + * @description The "Get team member" endpoint (described below) is closing down. * * 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. * @@ -105986,7 +111528,7 @@ export interface operations { /** * Add team member (Legacy) * @deprecated - * @description The "Add team member" endpoint (described below) is deprecated. + * @description The "Add team member" endpoint (described below) is closing down. * * 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. * @@ -105994,7 +111536,8 @@ export interface operations { * * 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)." */ @@ -106024,7 +111567,7 @@ export interface operations { /** * Remove team member (Legacy) * @deprecated - * @description The "Remove team member" endpoint (described below) is deprecated. + * @description The "Remove team member" endpoint (described below) is closing down. * * 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. * @@ -106032,7 +111575,8 @@ export interface operations { * * 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/)." */ "teams/remove-member-legacy": { parameters: { @@ -106055,7 +111599,8 @@ export interface operations { /** * 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. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down 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. * @@ -106086,13 +111631,15 @@ export interface operations { /** * 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. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down 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/)." + * > [!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. * @@ -106138,13 +111685,15 @@ export interface operations { /** * 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. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down 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/)." + * > [!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: { @@ -106167,7 +111716,8 @@ export interface operations { /** * 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. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down 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. */ @@ -106197,7 +111747,8 @@ export interface operations { /** * 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. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down 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. */ @@ -106224,7 +111775,8 @@ export interface operations { /** * 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. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down 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. */ @@ -106267,7 +111819,8 @@ export interface operations { /** * 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. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down 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. */ @@ -106290,7 +111843,8 @@ export interface operations { /** * 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. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down 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: { @@ -106318,11 +111872,13 @@ export interface operations { /** * Check team permissions for a repository (Legacy) * @deprecated - * @description **Note**: Repositories inherited through a parent team will also be checked. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down 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. + * > [!NOTE] + * > 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 `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/using-the-rest-api/getting-started-with-the-rest-api#media-types/) via the `Accept` header: */ "teams/check-permissions-for-repo-legacy": { parameters: { @@ -106352,7 +111908,8 @@ export interface operations { /** * 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. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down 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. * @@ -106389,7 +111946,8 @@ export interface operations { /** * 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. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down 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. */ @@ -106411,7 +111969,8 @@ export interface operations { /** * 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. + * @description > [!WARNING] + * > **Endpoint closing down notice:** This endpoint route is closing down 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: { @@ -106661,7 +112220,7 @@ export interface operations { /** @description The requested location for a new codespace. Best efforts are made to respect this upon creation. Assigned by IP if not provided. */ location?: string; /** - * @description The geographic area for this codespace. If not specified, the value is assigned by IP. This property replaces `location`, which is being deprecated. + * @description The geographic area for this codespace. If not specified, the value is assigned by IP. This property replaces `location`, which is closing down. * @enum {string} */ geo?: "EuropeWest" | "SoutheastAsia" | "UsEast" | "UsWest"; @@ -106693,7 +112252,7 @@ export interface operations { /** @description The requested location for a new codespace. Best efforts are made to respect this upon creation. Assigned by IP if not provided. */ location?: string; /** - * @description The geographic area for this codespace. If not specified, the value is assigned by IP. This property replaces `location`, which is being deprecated. + * @description The geographic area for this codespace. If not specified, the value is assigned by IP. This property replaces `location`, which is closing down. * @enum {string} */ geo?: "EuropeWest" | "SoutheastAsia" | "UsEast" | "UsWest"; @@ -107472,6 +113031,7 @@ export interface operations { 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; }; }; /** @@ -107677,6 +113237,8 @@ export interface operations { /** * 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. + * + * This endpoint only works for PATs (classic) with the `repo` scope. */ "apps/add-repo-to-installation-for-authenticated-user": { parameters: { @@ -107698,6 +113260,8 @@ export interface operations { /** * 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`. + * + * This endpoint only works for PATs (classic) with the `repo` scope. */ "apps/remove-repo-from-installation-for-authenticated-user": { parameters: { @@ -107776,10 +113340,8 @@ export interface operations { * 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)." * @@ -108311,6 +113873,9 @@ export interface operations { * @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. + * + * > [!NOTE] + * > Requests using a fine-grained access token will receive a `200 Success` response with an empty list. */ "orgs/list-for-authenticated-user": { parameters: { @@ -108338,7 +113903,7 @@ export interface operations { * 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. For more information, 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: { @@ -108370,7 +113935,7 @@ export interface operations { * 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. For more information, 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: { @@ -108392,7 +113957,7 @@ export interface operations { * 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. For more information, 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: { @@ -108419,7 +113984,7 @@ export interface operations { * - 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. For more information, 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: { @@ -108446,7 +114011,7 @@ export interface operations { * 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. For more information, 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: { @@ -108477,7 +114042,7 @@ export interface operations { * 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. For more information, 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: { @@ -108502,7 +114067,7 @@ export interface operations { * * 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. For more information, 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: { @@ -108530,7 +114095,7 @@ export interface operations { * - 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. For more information, 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: { @@ -108754,7 +114319,9 @@ export interface operations { */ delete_branch_on_merge?: boolean; /** - * @description The default value for a squash merge commit title: + * @description Required when using `squash_merge_commit_message`. + * + * The default value for a squash merge commit title: * * - `PR_TITLE` - default to the pull request's title. * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). @@ -108771,7 +114338,9 @@ export interface operations { */ squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** - * @description The default value for a merge commit title. + * @description Required when using `merge_commit_message`. + * + * The default value for a merge commit title. * * - `PR_TITLE` - default to the pull request's title. * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). @@ -109245,6 +114814,32 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; + /** + * Get a user using their ID + * @description Provides publicly available information about someone with a GitHub account. This method takes their durable user `ID` instead of their `login`, which can change over time. + * + * 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-id": { + parameters: { + path: { + account_id: components["parameters"]["account-id"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": + | components["schemas"]["private-user"] + | components["schemas"]["public-user"]; + }; + }; + 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. @@ -109298,6 +114893,53 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; + /** + * List attestations + * @description List a collection of artifact attestations with a given subject digest that are associated with repositories owned by a user. + * + * The collection of attestations returned by this endpoint is filtered according to the authenticated user's permissions; if the authenticated user cannot read a repository, the attestations associated with that repository will not be included in the response. In addition, when using a fine-grained access token the `attestations:read` permission is required. + * + * **Please note:** in order to offer meaningful security benefits, an attestation's signature and timestamps **must** be cryptographically verified, and the identity of the attestation signer **must** be validated. Attestations can be verified using the [GitHub CLI `attestation verify` command](https://cli.github.com/manual/gh_attestation_verify). For more information, see [our guide on how to use artifact attestations to establish a build's provenance](https://docs.github.com/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds). + */ + "users/list-attestations": { + parameters: { + query?: { + per_page?: components["parameters"]["per-page"]; + before?: components["parameters"]["pagination-before"]; + after?: components["parameters"]["pagination-after"]; + }; + path: { + username: components["parameters"]["username"]; + /** @description Subject Digest */ + subject_digest: string; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": { + attestations?: { + bundle?: components["schemas"]["sigstore-bundle-0"]; + repository_id?: number; + bundle_url?: string; + }[]; + }; + }; + }; + /** @description Response */ + 201: { + content: { + "application/json": components["schemas"]["empty-object"]; + }; + }; + /** @description Response */ + 204: { + content: never; + }; + 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. @@ -109323,7 +114965,10 @@ export interface operations { }; /** * 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. + * @description If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events. _Optional_: use the fine-grained token with following permission set to view private events: "Events" user permissions (read). + * + * > [!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-events-for-authenticated-user": { parameters: { @@ -109347,6 +114992,9 @@ export interface operations { /** * 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. + * + * > [!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-org-events-for-authenticated-user": { parameters: { @@ -109368,7 +115016,11 @@ export interface operations { }; }; }; - /** List public events for a user */ + /** + * List public events for a user + * @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-public-events-for-user": { parameters: { query?: { @@ -109623,7 +115275,7 @@ 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)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. For more information, 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: { @@ -109660,7 +115312,7 @@ export interface operations { * 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. For more information, 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: { @@ -109685,7 +115337,7 @@ export interface operations { * * 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. For more information, 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: { @@ -109715,7 +115367,7 @@ export interface operations { * * 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. For more information, 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: { @@ -109743,7 +115395,7 @@ export interface operations { * 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. For more information, 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: { @@ -109769,7 +115421,7 @@ export interface operations { * 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. For more information, 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: { @@ -109795,7 +115447,7 @@ export interface operations { * * 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. For more information, 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: { @@ -109826,7 +115478,7 @@ export interface operations { * * 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. For more information, 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: { @@ -109878,7 +115530,11 @@ export interface operations { }; /** * 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. + * @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. + * + * > [!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-received-events-for-user": { parameters: { @@ -109899,7 +115555,11 @@ export interface operations { }; }; }; - /** List public events received by a user */ + /** + * List public events received by a user + * @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-received-public-events-for-user": { parameters: { query?: { @@ -110228,4 +115888,37 @@ export interface operations { 500: components["responses"]["internal_error"]; }; }; + /** + * 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: { + path: { + org: components["parameters"]["org"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": { + name: string; + description: string; + }[]; + }; + }; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + }; + }; } diff --git a/node_modules/@octokit/request-error/node_modules/@octokit/types/dist-types/VERSION.d.ts b/node_modules/@octokit/request-error/node_modules/@octokit/types/dist-types/VERSION.d.ts index e36ca410..9d5f7d51 100644 --- a/node_modules/@octokit/request-error/node_modules/@octokit/types/dist-types/VERSION.d.ts +++ b/node_modules/@octokit/request-error/node_modules/@octokit/types/dist-types/VERSION.d.ts @@ -1 +1 @@ -export declare const VERSION = "13.6.2"; +export declare const VERSION = "13.7.0"; diff --git a/node_modules/@octokit/request-error/node_modules/@octokit/types/dist-types/generated/Endpoints.d.ts b/node_modules/@octokit/request-error/node_modules/@octokit/types/dist-types/generated/Endpoints.d.ts index 837e68ae..8adbfec5 100644 --- a/node_modules/@octokit/request-error/node_modules/@octokit/types/dist-types/generated/Endpoints.d.ts +++ b/node_modules/@octokit/request-error/node_modules/@octokit/types/dist-types/generated/Endpoints.d.ts @@ -75,6 +75,10 @@ export interface Endpoints { * @see https://docs.github.com/rest/apps/oauth-applications#delete-an-app-token */ "DELETE /applications/{client_id}/token": Operation<"/applications/{client_id}/token", "delete">; + /** + * @see https://docs.github.com/rest/code-security/configurations#delete-a-code-security-configuration-for-an-enterprise + */ + "DELETE /enterprises/{enterprise}/code-security/configurations/{configuration_id}": Operation<"/enterprises/{enterprise}/code-security/configurations/{configuration_id}", "delete">; /** * @see https://docs.github.com/rest/gists/gists#delete-a-gist */ @@ -107,6 +111,18 @@ export interface Endpoints { * @see https://docs.github.com/rest/actions/permissions#disable-a-selected-repository-for-github-actions-in-an-organization */ "DELETE /orgs/{org}/actions/permissions/repositories/{repository_id}": Operation<"/orgs/{org}/actions/permissions/repositories/{repository_id}", "delete">; + /** + * @see https://docs.github.com/rest/actions/self-hosted-runner-groups#delete-a-self-hosted-runner-group-from-an-organization + */ + "DELETE /orgs/{org}/actions/runner-groups/{runner_group_id}": Operation<"/orgs/{org}/actions/runner-groups/{runner_group_id}", "delete">; + /** + * @see https://docs.github.com/rest/actions/self-hosted-runner-groups#remove-repository-access-to-a-self-hosted-runner-group-in-an-organization + */ + "DELETE /orgs/{org}/actions/runner-groups/{runner_group_id}/repositories/{repository_id}": Operation<"/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories/{repository_id}", "delete">; + /** + * @see https://docs.github.com/rest/actions/self-hosted-runner-groups#remove-a-self-hosted-runner-from-a-group-for-an-organization + */ + "DELETE /orgs/{org}/actions/runner-groups/{runner_group_id}/runners/{runner_id}": Operation<"/orgs/{org}/actions/runner-groups/{runner_group_id}/runners/{runner_id}", "delete">; /** * @see https://docs.github.com/rest/actions/self-hosted-runners#delete-a-self-hosted-runner-from-an-organization */ @@ -139,6 +155,14 @@ export interface Endpoints { * @see https://docs.github.com/rest/orgs/blocking#unblock-a-user-from-an-organization */ "DELETE /orgs/{org}/blocks/{username}": Operation<"/orgs/{org}/blocks/{username}", "delete">; + /** + * @see https://docs.github.com/rest/code-security/configurations#detach-configurations-from-repositories + */ + "DELETE /orgs/{org}/code-security/configurations/detach": Operation<"/orgs/{org}/code-security/configurations/detach", "delete">; + /** + * @see https://docs.github.com/rest/code-security/configurations#delete-a-code-security-configuration + */ + "DELETE /orgs/{org}/code-security/configurations/{configuration_id}": Operation<"/orgs/{org}/code-security/configurations/{configuration_id}", "delete">; /** * @see https://docs.github.com/rest/codespaces/organizations#remove-users-from-codespaces-access-for-an-organization */ @@ -215,10 +239,6 @@ export interface Endpoints { * @see https://docs.github.com/rest/orgs/organization-roles#remove-an-organization-role-from-a-user */ "DELETE /orgs/{org}/organization-roles/users/{username}/{role_id}": Operation<"/orgs/{org}/organization-roles/users/{username}/{role_id}", "delete">; - /** - * @see https://docs.github.com/rest/orgs/organization-roles#delete-a-custom-organization-role - */ - "DELETE /orgs/{org}/organization-roles/{role_id}": Operation<"/orgs/{org}/organization-roles/{role_id}", "delete">; /** * @see https://docs.github.com/rest/orgs/outside-collaborators#remove-outside-collaborator-from-an-organization */ @@ -231,6 +251,10 @@ export interface Endpoints { * @see https://docs.github.com/rest/packages/packages#delete-package-version-for-an-organization */ "DELETE /orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}": Operation<"/orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}", "delete">; + /** + * @see https://docs.github.com/rest/private-registries/organization-configurations#delete-a-private-registry-for-an-organization + */ + "DELETE /orgs/{org}/private-registries/{secret_name}": Operation<"/orgs/{org}/private-registries/{secret_name}", "delete">; /** * @see https://docs.github.com/rest/orgs/custom-properties#remove-a-custom-property-for-an-organization */ @@ -391,6 +415,10 @@ export interface Endpoints { * @see https://docs.github.com/rest/code-scanning/code-scanning#delete-a-code-scanning-analysis-from-a-repository */ "DELETE /repos/{owner}/{repo}/code-scanning/analyses/{analysis_id}{?confirm_delete}": Operation<"/repos/{owner}/{repo}/code-scanning/analyses/{analysis_id}", "delete">; + /** + * @see https://docs.github.com/rest/code-scanning/code-scanning#delete-a-codeql-database + */ + "DELETE /repos/{owner}/{repo}/code-scanning/codeql/databases/{language}": Operation<"/repos/{owner}/{repo}/code-scanning/codeql/databases/{language}", "delete">; /** * @see https://docs.github.com/rest/codespaces/repository-secrets#delete-a-repository-secret */ @@ -487,6 +515,10 @@ export interface Endpoints { * @see https://docs.github.com/rest/reactions/reactions#delete-an-issue-reaction */ "DELETE /repos/{owner}/{repo}/issues/{issue_number}/reactions/{reaction_id}": Operation<"/repos/{owner}/{repo}/issues/{issue_number}/reactions/{reaction_id}", "delete">; + /** + * @see https://docs.github.com/rest/issues/sub-issues#remove-sub-issue + */ + "DELETE /repos/{owner}/{repo}/issues/{issue_number}/sub_issue": Operation<"/repos/{owner}/{repo}/issues/{issue_number}/sub_issue", "delete">; /** * @see https://docs.github.com/rest/deploy-keys/deploy-keys#delete-a-deploy-key */ @@ -544,7 +576,7 @@ export interface Endpoints { */ "DELETE /repos/{owner}/{repo}/subscription": Operation<"/repos/{owner}/{repo}/subscription", "delete">; /** - * @see https://docs.github.com/rest/repos/tags#delete-a-tag-protection-state-for-a-repository + * @see https://docs.github.com/rest/repos/tags#closing-down---delete-a-tag-protection-state-for-a-repository */ "DELETE /repos/{owner}/{repo}/tags/protection/{tag_protection_id}": Operation<"/repos/{owner}/{repo}/tags/protection/{tag_protection_id}", "delete">; /** @@ -740,9 +772,21 @@ export interface Endpoints { */ "GET /emojis": Operation<"/emojis", "get">; /** - * @see https://docs.github.com/rest/copilot/copilot-usage#get-a-summary-of-copilot-usage-for-enterprise-members + * @see https://docs.github.com/rest/code-security/configurations#get-code-security-configurations-for-an-enterprise */ - "GET /enterprises/{enterprise}/copilot/usage": Operation<"/enterprises/{enterprise}/copilot/usage", "get">; + "GET /enterprises/{enterprise}/code-security/configurations": Operation<"/enterprises/{enterprise}/code-security/configurations", "get">; + /** + * @see https://docs.github.com/rest/code-security/configurations#get-default-code-security-configurations-for-an-enterprise + */ + "GET /enterprises/{enterprise}/code-security/configurations/defaults": Operation<"/enterprises/{enterprise}/code-security/configurations/defaults", "get">; + /** + * @see https://docs.github.com/rest/code-security/configurations#retrieve-a-code-security-configuration-of-an-enterprise + */ + "GET /enterprises/{enterprise}/code-security/configurations/{configuration_id}": Operation<"/enterprises/{enterprise}/code-security/configurations/{configuration_id}", "get">; + /** + * @see https://docs.github.com/rest/code-security/configurations#get-repositories-associated-with-an-enterprise-code-security-configuration + */ + "GET /enterprises/{enterprise}/code-security/configurations/{configuration_id}/repositories": Operation<"/enterprises/{enterprise}/code-security/configurations/{configuration_id}/repositories", "get">; /** * @see https://docs.github.com/rest/dependabot/alerts#list-dependabot-alerts-for-an-enterprise */ @@ -875,6 +919,10 @@ export interface Endpoints { * @see https://docs.github.com/rest/orgs/orgs#list-organizations */ "GET /organizations": Operation<"/organizations", "get">; + /** + * @see https://docs.github.com/rest/billing/enhanced-billing#get-billing-usage-report-for-an-organization + */ + "GET /organizations/{org}/settings/billing/usage": Operation<"/organizations/{org}/settings/billing/usage", "get">; /** * @see https://docs.github.com/rest/codespaces/organizations#list-codespaces-for-the-organization * @deprecated "org_id" is now "org" @@ -912,6 +960,22 @@ export interface Endpoints { * @see https://docs.github.com/rest/actions/permissions#get-default-workflow-permissions-for-an-organization */ "GET /orgs/{org}/actions/permissions/workflow": Operation<"/orgs/{org}/actions/permissions/workflow", "get">; + /** + * @see https://docs.github.com/rest/actions/self-hosted-runner-groups#list-self-hosted-runner-groups-for-an-organization + */ + "GET /orgs/{org}/actions/runner-groups": Operation<"/orgs/{org}/actions/runner-groups", "get">; + /** + * @see https://docs.github.com/rest/actions/self-hosted-runner-groups#get-a-self-hosted-runner-group-for-an-organization + */ + "GET /orgs/{org}/actions/runner-groups/{runner_group_id}": Operation<"/orgs/{org}/actions/runner-groups/{runner_group_id}", "get">; + /** + * @see https://docs.github.com/rest/actions/self-hosted-runner-groups#list-repository-access-to-a-self-hosted-runner-group-in-an-organization + */ + "GET /orgs/{org}/actions/runner-groups/{runner_group_id}/repositories": Operation<"/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories", "get">; + /** + * @see https://docs.github.com/rest/actions/self-hosted-runner-groups#list-self-hosted-runners-in-a-group-for-an-organization + */ + "GET /orgs/{org}/actions/runner-groups/{runner_group_id}/runners": Operation<"/orgs/{org}/actions/runner-groups/{runner_group_id}/runners", "get">; /** * @see https://docs.github.com/rest/actions/self-hosted-runners#list-self-hosted-runners-for-an-organization */ @@ -956,6 +1020,10 @@ export interface Endpoints { * @see https://docs.github.com/rest/actions/variables#list-selected-repositories-for-an-organization-variable */ "GET /orgs/{org}/actions/variables/{name}/repositories": Operation<"/orgs/{org}/actions/variables/{name}/repositories", "get">; + /** + * @see https://docs.github.com/rest/orgs/orgs#list-attestations + */ + "GET /orgs/{org}/attestations/{subject_digest}": Operation<"/orgs/{org}/attestations/{subject_digest}", "get">; /** * @see https://docs.github.com/rest/orgs/blocking#list-users-blocked-by-an-organization */ @@ -968,6 +1036,22 @@ export interface Endpoints { * @see https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-alerts-for-an-organization */ "GET /orgs/{org}/code-scanning/alerts": Operation<"/orgs/{org}/code-scanning/alerts", "get">; + /** + * @see https://docs.github.com/rest/code-security/configurations#get-code-security-configurations-for-an-organization + */ + "GET /orgs/{org}/code-security/configurations": Operation<"/orgs/{org}/code-security/configurations", "get">; + /** + * @see https://docs.github.com/rest/code-security/configurations#get-default-code-security-configurations + */ + "GET /orgs/{org}/code-security/configurations/defaults": Operation<"/orgs/{org}/code-security/configurations/defaults", "get">; + /** + * @see https://docs.github.com/rest/code-security/configurations#get-a-code-security-configuration + */ + "GET /orgs/{org}/code-security/configurations/{configuration_id}": Operation<"/orgs/{org}/code-security/configurations/{configuration_id}", "get">; + /** + * @see https://docs.github.com/rest/code-security/configurations#get-repositories-associated-with-a-code-security-configuration + */ + "GET /orgs/{org}/code-security/configurations/{configuration_id}/repositories": Operation<"/orgs/{org}/code-security/configurations/{configuration_id}/repositories", "get">; /** * @see https://docs.github.com/rest/codespaces/organizations#list-codespaces-for-the-organization */ @@ -996,6 +1080,10 @@ export interface Endpoints { * @see https://docs.github.com/rest/copilot/copilot-user-management#list-all-copilot-seat-assignments-for-an-organization */ "GET /orgs/{org}/copilot/billing/seats": Operation<"/orgs/{org}/copilot/billing/seats", "get">; + /** + * @see https://docs.github.com/rest/copilot/copilot-metrics#get-copilot-metrics-for-an-organization + */ + "GET /orgs/{org}/copilot/metrics": Operation<"/orgs/{org}/copilot/metrics", "get">; /** * @see https://docs.github.com/rest/copilot/copilot-usage#get-a-summary-of-copilot-usage-for-organization-members */ @@ -1052,6 +1140,42 @@ export interface Endpoints { * @see https://docs.github.com/rest/orgs/webhooks#get-a-webhook-delivery-for-an-organization-webhook */ "GET /orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}": Operation<"/orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}", "get">; + /** + * @see https://docs.github.com/rest/orgs/api-insights#get-route-stats-by-actor + */ + "GET /orgs/{org}/insights/api/route-stats/{actor_type}/{actor_id}": Operation<"/orgs/{org}/insights/api/route-stats/{actor_type}/{actor_id}", "get">; + /** + * @see https://docs.github.com/rest/orgs/api-insights#get-subject-stats + */ + "GET /orgs/{org}/insights/api/subject-stats": Operation<"/orgs/{org}/insights/api/subject-stats", "get">; + /** + * @see https://docs.github.com/rest/orgs/api-insights#get-summary-stats + */ + "GET /orgs/{org}/insights/api/summary-stats": Operation<"/orgs/{org}/insights/api/summary-stats", "get">; + /** + * @see https://docs.github.com/rest/orgs/api-insights#get-summary-stats-by-user + */ + "GET /orgs/{org}/insights/api/summary-stats/users/{user_id}": Operation<"/orgs/{org}/insights/api/summary-stats/users/{user_id}", "get">; + /** + * @see https://docs.github.com/rest/orgs/api-insights#get-summary-stats-by-actor + */ + "GET /orgs/{org}/insights/api/summary-stats/{actor_type}/{actor_id}": Operation<"/orgs/{org}/insights/api/summary-stats/{actor_type}/{actor_id}", "get">; + /** + * @see https://docs.github.com/rest/orgs/api-insights#get-time-stats + */ + "GET /orgs/{org}/insights/api/time-stats": Operation<"/orgs/{org}/insights/api/time-stats", "get">; + /** + * @see https://docs.github.com/rest/orgs/api-insights#get-time-stats-by-user + */ + "GET /orgs/{org}/insights/api/time-stats/users/{user_id}": Operation<"/orgs/{org}/insights/api/time-stats/users/{user_id}", "get">; + /** + * @see https://docs.github.com/rest/orgs/api-insights#get-time-stats-by-actor + */ + "GET /orgs/{org}/insights/api/time-stats/{actor_type}/{actor_id}": Operation<"/orgs/{org}/insights/api/time-stats/{actor_type}/{actor_id}", "get">; + /** + * @see https://docs.github.com/rest/orgs/api-insights#get-user-stats + */ + "GET /orgs/{org}/insights/api/user-stats/{user_id}": Operation<"/orgs/{org}/insights/api/user-stats/{user_id}", "get">; /** * @see https://docs.github.com/rest/apps/apps#get-an-organization-installation-for-the-authenticated-app */ @@ -1168,6 +1292,18 @@ export interface Endpoints { * @see https://docs.github.com/rest/orgs/personal-access-tokens#list-repositories-a-fine-grained-personal-access-token-has-access-to */ "GET /orgs/{org}/personal-access-tokens/{pat_id}/repositories": Operation<"/orgs/{org}/personal-access-tokens/{pat_id}/repositories", "get">; + /** + * @see https://docs.github.com/rest/private-registries/organization-configurations#list-private-registries-for-an-organization + */ + "GET /orgs/{org}/private-registries": Operation<"/orgs/{org}/private-registries", "get">; + /** + * @see https://docs.github.com/rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization + */ + "GET /orgs/{org}/private-registries/public-key": Operation<"/orgs/{org}/private-registries/public-key", "get">; + /** + * @see https://docs.github.com/rest/private-registries/organization-configurations#get-a-private-registry-for-an-organization + */ + "GET /orgs/{org}/private-registries/{secret_name}": Operation<"/orgs/{org}/private-registries/{secret_name}", "get">; /** * @see https://docs.github.com/rest/projects/projects#list-organization-projects */ @@ -1236,6 +1372,10 @@ export interface Endpoints { * @see https://docs.github.com/rest/billing/billing#get-shared-storage-billing-for-an-organization */ "GET /orgs/{org}/settings/billing/shared-storage": Operation<"/orgs/{org}/settings/billing/shared-storage", "get">; + /** + * @see https://docs.github.com/rest/copilot/copilot-metrics#get-copilot-metrics-for-a-team + */ + "GET /orgs/{org}/team/{team_slug}/copilot/metrics": Operation<"/orgs/{org}/team/{team_slug}/copilot/metrics", "get">; /** * @see https://docs.github.com/rest/copilot/copilot-usage#get-a-summary-of-copilot-usage-for-a-team */ @@ -1504,6 +1644,10 @@ export interface Endpoints { * @see https://docs.github.com/rest/issues/assignees#check-if-a-user-can-be-assigned */ "GET /repos/{owner}/{repo}/assignees/{assignee}": Operation<"/repos/{owner}/{repo}/assignees/{assignee}", "get">; + /** + * @see https://docs.github.com/rest/repos/repos#list-attestations + */ + "GET /repos/{owner}/{repo}/attestations/{subject_digest}": Operation<"/repos/{owner}/{repo}/attestations/{subject_digest}", "get">; /** * @see https://docs.github.com/rest/repos/autolinks#get-all-autolinks-of-a-repository */ @@ -1593,6 +1737,10 @@ export interface Endpoints { * @see https://docs.github.com/rest/code-scanning/code-scanning#get-a-code-scanning-alert */ "GET /repos/{owner}/{repo}/code-scanning/alerts/{alert_number}": Operation<"/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}", "get">; + /** + * @see https://docs.github.com/rest/code-scanning/code-scanning#get-the-status-of-an-autofix-for-a-code-scanning-alert + */ + "GET /repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/autofix": Operation<"/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/autofix", "get">; /** * @see https://docs.github.com/rest/code-scanning/code-scanning#list-instances-of-a-code-scanning-alert */ @@ -1613,6 +1761,14 @@ export interface Endpoints { * @see https://docs.github.com/rest/code-scanning/code-scanning#get-a-codeql-database-for-a-repository */ "GET /repos/{owner}/{repo}/code-scanning/codeql/databases/{language}": Operation<"/repos/{owner}/{repo}/code-scanning/codeql/databases/{language}", "get">; + /** + * @see https://docs.github.com/rest/code-scanning/code-scanning#get-the-summary-of-a-codeql-variant-analysis + */ + "GET /repos/{owner}/{repo}/code-scanning/codeql/variant-analyses/{codeql_variant_analysis_id}": Operation<"/repos/{owner}/{repo}/code-scanning/codeql/variant-analyses/{codeql_variant_analysis_id}", "get">; + /** + * @see https://docs.github.com/rest/code-scanning/code-scanning#get-the-analysis-status-of-a-repository-in-a-codeql-variant-analysis + */ + "GET /repos/{owner}/{repo}/code-scanning/codeql/variant-analyses/{codeql_variant_analysis_id}/repos/{repo_owner}/{repo_name}": Operation<"/repos/{owner}/{repo}/code-scanning/codeql/variant-analyses/{codeql_variant_analysis_id}/repos/{repo_owner}/{repo_name}", "get">; /** * @see https://docs.github.com/rest/code-scanning/code-scanning#get-a-code-scanning-default-setup-configuration */ @@ -1621,6 +1777,10 @@ export interface Endpoints { * @see https://docs.github.com/rest/code-scanning/code-scanning#get-information-about-a-sarif-upload */ "GET /repos/{owner}/{repo}/code-scanning/sarifs/{sarif_id}": Operation<"/repos/{owner}/{repo}/code-scanning/sarifs/{sarif_id}", "get">; + /** + * @see https://docs.github.com/rest/code-security/configurations#get-the-code-security-configuration-associated-with-a-repository + */ + "GET /repos/{owner}/{repo}/code-security-configuration": Operation<"/repos/{owner}/{repo}/code-security-configuration", "get">; /** * @see https://docs.github.com/rest/repos/repos#list-codeowners-errors */ @@ -1953,6 +2113,10 @@ export interface Endpoints { * @see https://docs.github.com/rest/reactions/reactions#list-reactions-for-an-issue */ "GET /repos/{owner}/{repo}/issues/{issue_number}/reactions": Operation<"/repos/{owner}/{repo}/issues/{issue_number}/reactions", "get">; + /** + * @see https://docs.github.com/rest/issues/sub-issues#list-sub-issues + */ + "GET /repos/{owner}/{repo}/issues/{issue_number}/sub_issues": Operation<"/repos/{owner}/{repo}/issues/{issue_number}/sub_issues", "get">; /** * @see https://docs.github.com/rest/issues/timeline#list-timeline-events-for-an-issue */ @@ -2153,6 +2317,10 @@ export interface Endpoints { * @see https://docs.github.com/rest/secret-scanning/secret-scanning#list-locations-for-a-secret-scanning-alert */ "GET /repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}/locations": Operation<"/repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}/locations", "get">; + /** + * @see https://docs.github.com/rest/secret-scanning/secret-scanning#get-secret-scanning-scan-history-for-a-repository + */ + "GET /repos/{owner}/{repo}/secret-scanning/scan-history": Operation<"/repos/{owner}/{repo}/secret-scanning/scan-history", "get">; /** * @see https://docs.github.com/rest/security-advisories/repository-advisories#list-repository-security-advisories */ @@ -2198,7 +2366,7 @@ export interface Endpoints { */ "GET /repos/{owner}/{repo}/tags": Operation<"/repos/{owner}/{repo}/tags", "get">; /** - * @see https://docs.github.com/rest/repos/tags#list-tag-protection-states-for-a-repository + * @see https://docs.github.com/rest/repos/tags#closing-down---list-tag-protection-states-for-a-repository */ "GET /repos/{owner}/{repo}/tags/protection": Operation<"/repos/{owner}/{repo}/tags/protection", "get">; /** @@ -2521,6 +2689,10 @@ export interface Endpoints { * @see https://docs.github.com/rest/teams/teams#list-teams-for-the-authenticated-user */ "GET /user/teams": Operation<"/user/teams", "get">; + /** + * @see https://docs.github.com/rest/users/users#get-a-user-using-their-id + */ + "GET /user/{account_id}": Operation<"/user/{account_id}", "get">; /** * @see https://docs.github.com/rest/users/users#list-users */ @@ -2529,6 +2701,10 @@ export interface Endpoints { * @see https://docs.github.com/rest/users/users#get-a-user */ "GET /users/{username}": Operation<"/users/{username}", "get">; + /** + * @see https://docs.github.com/rest/users/attestations#list-attestations + */ + "GET /users/{username}/attestations/{subject_digest}": Operation<"/users/{username}/attestations/{subject_digest}", "get">; /** * @see https://docs.github.com/rest/packages/packages#get-list-of-conflicting-packages-during-docker-migration-for-user */ @@ -2657,6 +2833,10 @@ export interface Endpoints { * @see https://docs.github.com/rest/apps/oauth-applications#reset-a-token */ "PATCH /applications/{client_id}/token": Operation<"/applications/{client_id}/token", "patch">; + /** + * @see https://docs.github.com/rest/code-security/configurations#update-a-custom-code-security-configuration-for-an-enterprise + */ + "PATCH /enterprises/{enterprise}/code-security/configurations/{configuration_id}": Operation<"/enterprises/{enterprise}/code-security/configurations/{configuration_id}", "patch">; /** * @see https://docs.github.com/rest/reference/gists/#update-a-gist */ @@ -2673,10 +2853,18 @@ export interface Endpoints { * @see https://docs.github.com/rest/orgs/orgs#update-an-organization */ "PATCH /orgs/{org}": Operation<"/orgs/{org}", "patch">; + /** + * @see https://docs.github.com/rest/actions/self-hosted-runner-groups#update-a-self-hosted-runner-group-for-an-organization + */ + "PATCH /orgs/{org}/actions/runner-groups/{runner_group_id}": Operation<"/orgs/{org}/actions/runner-groups/{runner_group_id}", "patch">; /** * @see https://docs.github.com/rest/actions/variables#update-an-organization-variable */ "PATCH /orgs/{org}/actions/variables/{name}": Operation<"/orgs/{org}/actions/variables/{name}", "patch">; + /** + * @see https://docs.github.com/rest/code-security/configurations#update-a-code-security-configuration + */ + "PATCH /orgs/{org}/code-security/configurations/{configuration_id}": Operation<"/orgs/{org}/code-security/configurations/{configuration_id}", "patch">; /** * @see https://docs.github.com/rest/orgs/webhooks#update-an-organization-webhook */ @@ -2686,9 +2874,9 @@ export interface Endpoints { */ "PATCH /orgs/{org}/hooks/{hook_id}/config": Operation<"/orgs/{org}/hooks/{hook_id}/config", "patch">; /** - * @see https://docs.github.com/rest/orgs/organization-roles#update-a-custom-organization-role + * @see https://docs.github.com/rest/private-registries/organization-configurations#update-a-private-registry-for-an-organization */ - "PATCH /orgs/{org}/organization-roles/{role_id}": Operation<"/orgs/{org}/organization-roles/{role_id}", "patch">; + "PATCH /orgs/{org}/private-registries/{secret_name}": Operation<"/orgs/{org}/private-registries/{secret_name}", "patch">; /** * @see https://docs.github.com/rest/orgs/custom-properties#create-or-update-custom-properties-for-an-organization */ @@ -2801,6 +2989,10 @@ export interface Endpoints { * @see https://docs.github.com/rest/issues/issues#update-an-issue */ "PATCH /repos/{owner}/{repo}/issues/{issue_number}": Operation<"/repos/{owner}/{repo}/issues/{issue_number}", "patch">; + /** + * @see https://docs.github.com/rest/issues/sub-issues#reprioritize-sub-issue + */ + "PATCH /repos/{owner}/{repo}/issues/{issue_number}/sub_issues/priority": Operation<"/repos/{owner}/{repo}/issues/{issue_number}/sub_issues/priority", "patch">; /** * @see https://docs.github.com/rest/issues/labels#update-a-label */ @@ -2889,6 +3081,14 @@ export interface Endpoints { * @see https://docs.github.com/rest/apps/apps#create-a-scoped-access-token */ "POST /applications/{client_id}/token/scoped": Operation<"/applications/{client_id}/token/scoped", "post">; + /** + * @see https://docs.github.com/rest/code-security/configurations#create-a-code-security-configuration-for-an-enterprise + */ + "POST /enterprises/{enterprise}/code-security/configurations": Operation<"/enterprises/{enterprise}/code-security/configurations", "post">; + /** + * @see https://docs.github.com/rest/code-security/configurations#attach-an-enterprise-configuration-to-repositories + */ + "POST /enterprises/{enterprise}/code-security/configurations/{configuration_id}/attach": Operation<"/enterprises/{enterprise}/code-security/configurations/{configuration_id}/attach", "post">; /** * @see https://docs.github.com/rest/gists/gists#create-a-gist */ @@ -2909,6 +3109,10 @@ export interface Endpoints { * @see https://docs.github.com/rest/markdown/markdown#render-a-markdown-document-in-raw-mode */ "POST /markdown/raw": Operation<"/markdown/raw", "post">; + /** + * @see https://docs.github.com/rest/actions/self-hosted-runner-groups#create-a-self-hosted-runner-group-for-an-organization + */ + "POST /orgs/{org}/actions/runner-groups": Operation<"/orgs/{org}/actions/runner-groups", "post">; /** * @see https://docs.github.com/rest/actions/self-hosted-runners#create-configuration-for-a-just-in-time-runner-for-an-organization */ @@ -2929,6 +3133,14 @@ export interface Endpoints { * @see https://docs.github.com/rest/actions/variables#create-an-organization-variable */ "POST /orgs/{org}/actions/variables": Operation<"/orgs/{org}/actions/variables", "post">; + /** + * @see https://docs.github.com/rest/code-security/configurations#create-a-code-security-configuration + */ + "POST /orgs/{org}/code-security/configurations": Operation<"/orgs/{org}/code-security/configurations", "post">; + /** + * @see https://docs.github.com/rest/code-security/configurations#attach-a-configuration-to-repositories + */ + "POST /orgs/{org}/code-security/configurations/{configuration_id}/attach": Operation<"/orgs/{org}/code-security/configurations/{configuration_id}/attach", "post">; /** * @see https://docs.github.com/rest/codespaces/organizations#add-users-to-codespaces-access-for-an-organization */ @@ -2965,10 +3177,6 @@ export interface Endpoints { * @see https://docs.github.com/rest/migrations/orgs#start-an-organization-migration */ "POST /orgs/{org}/migrations": Operation<"/orgs/{org}/migrations", "post">; - /** - * @see https://docs.github.com/rest/orgs/organization-roles#create-a-custom-organization-role - */ - "POST /orgs/{org}/organization-roles": Operation<"/orgs/{org}/organization-roles", "post">; /** * @see https://docs.github.com/rest/packages/packages#restore-a-package-for-an-organization */ @@ -2993,6 +3201,10 @@ export interface Endpoints { * @see https://docs.github.com/rest/orgs/personal-access-tokens#update-the-access-a-fine-grained-personal-access-token-has-to-organization-resources */ "POST /orgs/{org}/personal-access-tokens/{pat_id}": Operation<"/orgs/{org}/personal-access-tokens/{pat_id}", "post">; + /** + * @see https://docs.github.com/rest/private-registries/organization-configurations#create-a-private-registry-for-an-organization + */ + "POST /orgs/{org}/private-registries": Operation<"/orgs/{org}/private-registries", "post">; /** * @see https://docs.github.com/rest/projects/projects#create-an-organization-project */ @@ -3101,6 +3313,10 @@ export interface Endpoints { * @see https://docs.github.com/rest/actions/workflows#create-a-workflow-dispatch-event */ "POST /repos/{owner}/{repo}/actions/workflows/{workflow_id}/dispatches": Operation<"/repos/{owner}/{repo}/actions/workflows/{workflow_id}/dispatches", "post">; + /** + * @see https://docs.github.com/rest/repos/repos#create-an-attestation + */ + "POST /repos/{owner}/{repo}/attestations": Operation<"/repos/{owner}/{repo}/attestations", "post">; /** * @see https://docs.github.com/rest/repos/autolinks#create-an-autolink-reference-for-a-repository */ @@ -3149,6 +3365,18 @@ export interface Endpoints { * @see https://docs.github.com/rest/checks/suites#rerequest-a-check-suite */ "POST /repos/{owner}/{repo}/check-suites/{check_suite_id}/rerequest": Operation<"/repos/{owner}/{repo}/check-suites/{check_suite_id}/rerequest", "post">; + /** + * @see https://docs.github.com/rest/code-scanning/code-scanning#create-an-autofix-for-a-code-scanning-alert + */ + "POST /repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/autofix": Operation<"/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/autofix", "post">; + /** + * @see https://docs.github.com/rest/code-scanning/code-scanning#commit-an-autofix-for-a-code-scanning-alert + */ + "POST /repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/autofix/commits": Operation<"/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/autofix/commits", "post">; + /** + * @see https://docs.github.com/rest/code-scanning/code-scanning#create-a-codeql-variant-analysis + */ + "POST /repos/{owner}/{repo}/code-scanning/codeql/variant-analyses": Operation<"/repos/{owner}/{repo}/code-scanning/codeql/variant-analyses", "post">; /** * @see https://docs.github.com/rest/code-scanning/code-scanning#upload-an-analysis-as-sarif-data */ @@ -3257,6 +3485,10 @@ export interface Endpoints { * @see https://docs.github.com/rest/reactions/reactions#create-reaction-for-an-issue */ "POST /repos/{owner}/{repo}/issues/{issue_number}/reactions": Operation<"/repos/{owner}/{repo}/issues/{issue_number}/reactions", "post">; + /** + * @see https://docs.github.com/rest/issues/sub-issues#add-sub-issue + */ + "POST /repos/{owner}/{repo}/issues/{issue_number}/sub_issues": Operation<"/repos/{owner}/{repo}/issues/{issue_number}/sub_issues", "post">; /** * @see https://docs.github.com/rest/deploy-keys/deploy-keys#create-a-deploy-key */ @@ -3345,6 +3577,10 @@ export interface Endpoints { * @see https://docs.github.com/rest/repos/rules#create-a-repository-ruleset */ "POST /repos/{owner}/{repo}/rulesets": Operation<"/repos/{owner}/{repo}/rulesets", "post">; + /** + * @see https://docs.github.com/rest/secret-scanning/secret-scanning#create-a-push-protection-bypass + */ + "POST /repos/{owner}/{repo}/secret-scanning/push-protection-bypasses": Operation<"/repos/{owner}/{repo}/secret-scanning/push-protection-bypasses", "post">; /** * @see https://docs.github.com/rest/security-advisories/repository-advisories#create-a-repository-security-advisory */ @@ -3366,7 +3602,7 @@ export interface Endpoints { */ "POST /repos/{owner}/{repo}/statuses/{sha}": Operation<"/repos/{owner}/{repo}/statuses/{sha}", "post">; /** - * @see https://docs.github.com/rest/repos/tags#create-a-tag-protection-state-for-a-repository + * @see https://docs.github.com/rest/repos/tags#closing-down---create-a-tag-protection-state-for-a-repository */ "POST /repos/{owner}/{repo}/tags/protection": Operation<"/repos/{owner}/{repo}/tags/protection", "post">; /** @@ -3469,6 +3705,10 @@ export interface Endpoints { * @see https://docs.github.com/rest/apps/apps#suspend-an-app-installation */ "PUT /app/installations/{installation_id}/suspended": Operation<"/app/installations/{installation_id}/suspended", "put">; + /** + * @see https://docs.github.com/rest/code-security/configurations#set-a-code-security-configuration-as-a-default-for-an-enterprise + */ + "PUT /enterprises/{enterprise}/code-security/configurations/{configuration_id}/defaults": Operation<"/enterprises/{enterprise}/code-security/configurations/{configuration_id}/defaults", "put">; /** * @see https://docs.github.com/rest/gists/gists#star-a-gist */ @@ -3505,6 +3745,22 @@ export interface Endpoints { * @see https://docs.github.com/rest/actions/permissions#set-default-workflow-permissions-for-an-organization */ "PUT /orgs/{org}/actions/permissions/workflow": Operation<"/orgs/{org}/actions/permissions/workflow", "put">; + /** + * @see https://docs.github.com/rest/actions/self-hosted-runner-groups#set-repository-access-for-a-self-hosted-runner-group-in-an-organization + */ + "PUT /orgs/{org}/actions/runner-groups/{runner_group_id}/repositories": Operation<"/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories", "put">; + /** + * @see https://docs.github.com/rest/actions/self-hosted-runner-groups#add-repository-access-to-a-self-hosted-runner-group-in-an-organization + */ + "PUT /orgs/{org}/actions/runner-groups/{runner_group_id}/repositories/{repository_id}": Operation<"/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories/{repository_id}", "put">; + /** + * @see https://docs.github.com/rest/actions/self-hosted-runner-groups#set-self-hosted-runners-in-a-group-for-an-organization + */ + "PUT /orgs/{org}/actions/runner-groups/{runner_group_id}/runners": Operation<"/orgs/{org}/actions/runner-groups/{runner_group_id}/runners", "put">; + /** + * @see https://docs.github.com/rest/actions/self-hosted-runner-groups#add-a-self-hosted-runner-to-a-group-for-an-organization + */ + "PUT /orgs/{org}/actions/runner-groups/{runner_group_id}/runners/{runner_id}": Operation<"/orgs/{org}/actions/runner-groups/{runner_group_id}/runners/{runner_id}", "put">; /** * @see https://docs.github.com/rest/actions/self-hosted-runners#set-custom-labels-for-a-self-hosted-runner-for-an-organization */ @@ -3533,6 +3789,10 @@ export interface Endpoints { * @see https://docs.github.com/rest/orgs/blocking#block-a-user-from-an-organization */ "PUT /orgs/{org}/blocks/{username}": Operation<"/orgs/{org}/blocks/{username}", "put">; + /** + * @see https://docs.github.com/rest/code-security/configurations#set-a-code-security-configuration-as-a-default-for-an-organization + */ + "PUT /orgs/{org}/code-security/configurations/{configuration_id}/defaults": Operation<"/orgs/{org}/code-security/configurations/{configuration_id}/defaults", "put">; /** * @see https://docs.github.com/rest/codespaces/organizations#manage-access-control-for-organization-codespaces */ diff --git a/node_modules/@octokit/request-error/node_modules/@octokit/types/package.json b/node_modules/@octokit/request-error/node_modules/@octokit/types/package.json index 1c4494f1..b99f7a4f 100644 --- a/node_modules/@octokit/request-error/node_modules/@octokit/types/package.json +++ b/node_modules/@octokit/request-error/node_modules/@octokit/types/package.json @@ -1,13 +1,13 @@ { "name": "@octokit/types", - "version": "13.6.2", + "version": "13.7.0", "publishConfig": { "access": "public", "provenance": true }, "description": "Shared TypeScript definitions for Octokit projects", "dependencies": { - "@octokit/openapi-types": "^22.2.0" + "@octokit/openapi-types": "^23.0.1" }, "repository": "github:octokit/types.ts", "keywords": [ @@ -21,7 +21,7 @@ "license": "MIT", "devDependencies": { "@octokit/tsconfig": "^4.0.0", - "github-openapi-graphql-query": "^4.0.0", + "github-openapi-graphql-query": "^4.5.0", "handlebars": "^4.7.6", "npm-run-all2": "^7.0.0", "prettier": "^3.0.0", @@ -32,7 +32,7 @@ "typescript": "^5.0.0" }, "octokit": { - "openapi-version": "16.5.0" + "openapi-version": "17.1.1" }, "files": [ "dist-types/**" diff --git a/node_modules/agent-base/dist/index.d.ts.map b/node_modules/agent-base/dist/index.d.ts.map index 2dd91690..25cdb5d3 100644 --- a/node_modules/agent-base/dist/index.d.ts.map +++ b/node_modules/agent-base/dist/index.d.ts.map @@ -1 +1 @@ -{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;AAAA,OAAO,KAAK,GAAG,MAAM,KAAK,CAAC;AAC3B,OAAO,KAAK,GAAG,MAAM,KAAK,CAAC;AAC3B,OAAO,KAAK,IAAI,MAAM,MAAM,CAAC;AAE7B,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAErC,cAAc,WAAW,CAAC;AAE1B,UAAU,eAAgB,SAAQ,GAAG,CAAC,iBAAiB;IACtD,cAAc,EAAE,KAAK,CAAC;IACtB,QAAQ,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,UAAU,gBAAiB,SAAQ,GAAG,CAAC,iBAAiB;IACvD,cAAc,EAAE,IAAI,CAAC;IACrB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,IAAI,EAAE,MAAM,CAAC;CACb;AAED,MAAM,MAAM,gBAAgB,GAAG,eAAe,GAAG,gBAAgB,CAAC;AAElE,QAAA,MAAM,QAAQ,eAAmC,CAAC;AAQlD,8BAAsB,KAAM,SAAQ,IAAI,CAAC,KAAK;IAC7C,OAAO,CAAC,CAAC,QAAQ,CAAC,CAAgB;IAGlC,OAAO,EAAG,OAAO,CAAC,GAAG,CAAC,iBAAiB,GAAG,GAAG,CAAC,iBAAiB,CAAC,CAAC;IACjE,SAAS,EAAG,OAAO,CAAC;gBAER,IAAI,CAAC,EAAE,IAAI,CAAC,YAAY;IAKpC,QAAQ,CAAC,OAAO,CACf,GAAG,EAAE,IAAI,CAAC,aAAa,EACvB,OAAO,EAAE,gBAAgB,GACvB,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,MAAM,GAAG,IAAI,CAAC,KAAK;IAErD;;OAEG;IACH,gBAAgB,CAAC,OAAO,CAAC,EAAE,gBAAgB,GAAG,OAAO;IAqCrD,OAAO,CAAC,gBAAgB;IAqBxB,OAAO,CAAC,gBAAgB;IAmBxB,OAAO,CAAC,OAAO,EAAE,gBAAgB,GAAG,MAAM;IAa1C,YAAY,CACX,GAAG,EAAE,IAAI,CAAC,aAAa,EACvB,OAAO,EAAE,gBAAgB,EACzB,EAAE,EAAE,CAAC,GAAG,EAAE,KAAK,GAAG,IAAI,EAAE,CAAC,CAAC,EAAE,MAAM,KAAK,IAAI;IA4B5C,gBAAgB,IAAI,MAAM;IAW1B,IAAI,WAAW,IAAI,MAAM,CAKxB;IAED,IAAI,WAAW,CAAC,CAAC,EAAE,MAAM,EAIxB;IAED,IAAI,QAAQ,IAAI,MAAM,CAKrB;IAED,IAAI,QAAQ,CAAC,CAAC,EAAE,MAAM,EAIrB;CACD"} \ No newline at end of file +{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;AAAA,OAAO,KAAK,GAAG,MAAM,KAAK,CAAC;AAC3B,OAAO,KAAK,GAAG,MAAM,KAAK,CAAC;AAC3B,OAAO,KAAK,IAAI,MAAM,MAAM,CAAC;AAE7B,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAErC,cAAc,WAAW,CAAC;AAE1B,UAAU,eAAgB,SAAQ,GAAG,CAAC,iBAAiB;IACtD,cAAc,EAAE,KAAK,CAAC;IACtB,QAAQ,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,UAAU,gBAAiB,SAAQ,GAAG,CAAC,iBAAiB;IACvD,cAAc,EAAE,IAAI,CAAC;IACrB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,IAAI,EAAE,MAAM,CAAC;CACb;AAED,MAAM,MAAM,gBAAgB,GAAG,eAAe,GAAG,gBAAgB,CAAC;AAElE,QAAA,MAAM,QAAQ,eAAmC,CAAC;AAQlD,8BAAsB,KAAM,SAAQ,IAAI,CAAC,KAAK;IAC7C,OAAO,CAAC,CAAC,QAAQ,CAAC,CAAgB;IAGlC,OAAO,EAAG,OAAO,CAAC,GAAG,CAAC,iBAAiB,GAAG,GAAG,CAAC,iBAAiB,CAAC,CAAC;IACjE,SAAS,EAAG,OAAO,CAAC;gBAER,IAAI,CAAC,EAAE,IAAI,CAAC,YAAY;IAKpC,QAAQ,CAAC,OAAO,CACf,GAAG,EAAE,IAAI,CAAC,aAAa,EACvB,OAAO,EAAE,gBAAgB,GACvB,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,MAAM,GAAG,IAAI,CAAC,KAAK;IAErD;;OAEG;IACH,gBAAgB,CAAC,OAAO,CAAC,EAAE,gBAAgB,GAAG,OAAO;IAqCrD,OAAO,CAAC,gBAAgB;IAqBxB,OAAO,CAAC,gBAAgB;IAmBxB,OAAO,CAAC,OAAO,EAAE,gBAAgB,GAAG,MAAM;IAa1C,YAAY,CACX,GAAG,EAAE,IAAI,CAAC,aAAa,EACvB,OAAO,EAAE,gBAAgB,EACzB,EAAE,EAAE,CAAC,GAAG,EAAE,KAAK,GAAG,IAAI,EAAE,CAAC,CAAC,EAAE,MAAM,KAAK,IAAI;IAgC5C,gBAAgB,IAAI,MAAM;IAW1B,IAAI,WAAW,IAAI,MAAM,CAKxB;IAED,IAAI,WAAW,CAAC,CAAC,EAAE,MAAM,EAIxB;IAED,IAAI,QAAQ,IAAI,MAAM,CAKrB;IAED,IAAI,QAAQ,CAAC,CAAC,EAAE,MAAM,EAIrB;CACD"} \ No newline at end of file diff --git a/node_modules/agent-base/dist/index.js b/node_modules/agent-base/dist/index.js index 69396356..c3c4099c 100644 --- a/node_modules/agent-base/dist/index.js +++ b/node_modules/agent-base/dist/index.js @@ -133,8 +133,13 @@ class Agent extends http.Agent { .then((socket) => { this.decrementSockets(name, fakeSocket); if (socket instanceof http.Agent) { - // @ts-expect-error `addRequest()` isn't defined in `@types/node` - return socket.addRequest(req, connectOpts); + try { + // @ts-expect-error `addRequest()` isn't defined in `@types/node` + return socket.addRequest(req, connectOpts); + } + catch (err) { + return cb(err); + } } this[INTERNAL].currentSocket = socket; // @ts-expect-error `createSocket()` isn't defined in `@types/node` diff --git a/node_modules/agent-base/dist/index.js.map b/node_modules/agent-base/dist/index.js.map index cff41b84..d6e768c6 100644 --- a/node_modules/agent-base/dist/index.js.map +++ b/node_modules/agent-base/dist/index.js.map @@ -1 +1 @@ -{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,yCAA2B;AAE3B,2CAA6B;AAC7B,iCAA4C;AAG5C,4CAA0B;AAe1B,MAAM,QAAQ,GAAG,MAAM,CAAC,wBAAwB,CAAC,CAAC;AAQlD,MAAsB,KAAM,SAAQ,IAAI,CAAC,KAAK;IAO7C,YAAY,IAAwB;QACnC,KAAK,CAAC,IAAI,CAAC,CAAC;QACZ,IAAI,CAAC,QAAQ,CAAC,GAAG,EAAE,CAAC;IACrB,CAAC;IAOD;;OAEG;IACH,gBAAgB,CAAC,OAA0B;QAC1C,IAAI,OAAO,EAAE;YACZ,mEAAmE;YACnE,qEAAqE;YACrE,8DAA8D;YAC9D,IAAI,OAAQ,OAAe,CAAC,cAAc,KAAK,SAAS,EAAE;gBACzD,OAAO,OAAO,CAAC,cAAc,CAAC;aAC9B;YAED,oEAAoE;YACpE,mEAAmE;YACnE,qDAAqD;YACrD,IAAI,OAAO,OAAO,CAAC,QAAQ,KAAK,QAAQ,EAAE;gBACzC,OAAO,OAAO,CAAC,QAAQ,KAAK,QAAQ,CAAC;aACrC;SACD;QAED,gEAAgE;QAChE,iEAAiE;QACjE,6BAA6B;QAC7B,MAAM,EAAE,KAAK,EAAE,GAAG,IAAI,KAAK,EAAE,CAAC;QAC9B,IAAI,OAAO,KAAK,KAAK,QAAQ;YAAE,OAAO,KAAK,CAAC;QAC5C,OAAO,KAAK;aACV,KAAK,CAAC,IAAI,CAAC;aACX,IAAI,CACJ,CAAC,CAAC,EAAE,EAAE,CACL,CAAC,CAAC,OAAO,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC;YAC9B,CAAC,CAAC,OAAO,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC,CAChC,CAAC;IACJ,CAAC;IAED,wEAAwE;IACxE,2EAA2E;IAC3E,yEAAyE;IACzE,6EAA6E;IAC7E,kEAAkE;IAClE,sBAAsB;IACd,gBAAgB,CAAC,IAAY;QACpC,2EAA2E;QAC3E,yEAAyE;QACzE,yBAAyB;QACzB,IAAI,IAAI,CAAC,UAAU,KAAK,QAAQ,IAAI,IAAI,CAAC,eAAe,KAAK,QAAQ,EAAE;YACtE,OAAO,IAAI,CAAC;SACZ;QACD,iEAAiE;QACjE,wEAAwE;QACxE,qCAAqC;QACrC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE;YACxB,0DAA0D;YAC1D,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC;SACxB;QACD,MAAM,UAAU,GAAG,IAAI,GAAG,CAAC,MAAM,CAAC,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC,CAAC;QACtD,IAAI,CAAC,OAAO,CAAC,IAAI,CAAkB,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QACtD,qEAAqE;QACrE,IAAI,CAAC,gBAAgB,EAAE,CAAC;QACxB,OAAO,UAAU,CAAC;IACnB,CAAC;IAEO,gBAAgB,CAAC,IAAY,EAAE,MAAyB;QAC/D,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,MAAM,KAAK,IAAI,EAAE;YAC3C,OAAO;SACP;QACD,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAiB,CAAC;QACnD,MAAM,KAAK,GAAG,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;QACtC,IAAI,KAAK,KAAK,CAAC,CAAC,EAAE;YACjB,OAAO,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;YACzB,sEAAsE;YACtE,IAAI,CAAC,gBAAgB,EAAE,CAAC;YACxB,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC,EAAE;gBACzB,0DAA0D;gBAC1D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;aAC1B;SACD;IACF,CAAC;IAED,8EAA8E;IAC9E,oDAAoD;IACpD,OAAO,CAAC,OAAyB;QAChC,MAAM,cAAc,GACnB,OAAO,OAAO,CAAC,cAAc,KAAK,SAAS;YAC1C,CAAC,CAAC,OAAO,CAAC,cAAc;YACxB,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;QACnC,IAAI,cAAc,EAAE;YACnB,8DAA8D;YAC9D,OAAO,aAAU,CAAC,SAAS,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;SACxD;QACD,8DAA8D;QAC9D,OAAO,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;IAC/B,CAAC;IAED,YAAY,CACX,GAAuB,EACvB,OAAyB,EACzB,EAA2C;QAE3C,MAAM,WAAW,GAAG;YACnB,GAAG,OAAO;YACV,cAAc,EAAE,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC;SAC9C,CAAC;QACF,MAAM,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;QACvC,MAAM,UAAU,GAAG,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC;QAC/C,OAAO,CAAC,OAAO,EAAE;aACf,IAAI,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,WAAW,CAAC,CAAC;aAC1C,IAAI,CACJ,CAAC,MAAM,EAAE,EAAE;YACV,IAAI,CAAC,gBAAgB,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;YACxC,IAAI,MAAM,YAAY,IAAI,CAAC,KAAK,EAAE;gBACjC,iEAAiE;gBACjE,OAAO,MAAM,CAAC,UAAU,CAAC,GAAG,EAAE,WAAW,CAAC,CAAC;aAC3C;YACD,IAAI,CAAC,QAAQ,CAAC,CAAC,aAAa,GAAG,MAAM,CAAC;YACtC,mEAAmE;YACnE,KAAK,CAAC,YAAY,CAAC,GAAG,EAAE,OAAO,EAAE,EAAE,CAAC,CAAC;QACtC,CAAC,EACD,CAAC,GAAG,EAAE,EAAE;YACP,IAAI,CAAC,gBAAgB,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;YACxC,EAAE,CAAC,GAAG,CAAC,CAAC;QACT,CAAC,CACD,CAAC;IACJ,CAAC;IAED,gBAAgB;QACf,MAAM,MAAM,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAC,aAAa,CAAC;QAC5C,IAAI,CAAC,QAAQ,CAAC,CAAC,aAAa,GAAG,SAAS,CAAC;QACzC,IAAI,CAAC,MAAM,EAAE;YACZ,MAAM,IAAI,KAAK,CACd,oDAAoD,CACpD,CAAC;SACF;QACD,OAAO,MAAM,CAAC;IACf,CAAC;IAED,IAAI,WAAW;QACd,OAAO,CACN,IAAI,CAAC,QAAQ,CAAC,CAAC,WAAW;YAC1B,CAAC,IAAI,CAAC,QAAQ,KAAK,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CACvC,CAAC;IACH,CAAC;IAED,IAAI,WAAW,CAAC,CAAS;QACxB,IAAI,IAAI,CAAC,QAAQ,CAAC,EAAE;YACnB,IAAI,CAAC,QAAQ,CAAC,CAAC,WAAW,GAAG,CAAC,CAAC;SAC/B;IACF,CAAC;IAED,IAAI,QAAQ;QACX,OAAO,CACN,IAAI,CAAC,QAAQ,CAAC,CAAC,QAAQ;YACvB,CAAC,IAAI,CAAC,gBAAgB,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,CAC9C,CAAC;IACH,CAAC;IAED,IAAI,QAAQ,CAAC,CAAS;QACrB,IAAI,IAAI,CAAC,QAAQ,CAAC,EAAE;YACnB,IAAI,CAAC,QAAQ,CAAC,CAAC,QAAQ,GAAG,CAAC,CAAC;SAC5B;IACF,CAAC;CACD;AAjLD,sBAiLC"} \ No newline at end of file +{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,yCAA2B;AAE3B,2CAA6B;AAC7B,iCAA4C;AAG5C,4CAA0B;AAe1B,MAAM,QAAQ,GAAG,MAAM,CAAC,wBAAwB,CAAC,CAAC;AAQlD,MAAsB,KAAM,SAAQ,IAAI,CAAC,KAAK;IAO7C,YAAY,IAAwB;QACnC,KAAK,CAAC,IAAI,CAAC,CAAC;QACZ,IAAI,CAAC,QAAQ,CAAC,GAAG,EAAE,CAAC;IACrB,CAAC;IAOD;;OAEG;IACH,gBAAgB,CAAC,OAA0B;QAC1C,IAAI,OAAO,EAAE;YACZ,mEAAmE;YACnE,qEAAqE;YACrE,8DAA8D;YAC9D,IAAI,OAAQ,OAAe,CAAC,cAAc,KAAK,SAAS,EAAE;gBACzD,OAAO,OAAO,CAAC,cAAc,CAAC;aAC9B;YAED,oEAAoE;YACpE,mEAAmE;YACnE,qDAAqD;YACrD,IAAI,OAAO,OAAO,CAAC,QAAQ,KAAK,QAAQ,EAAE;gBACzC,OAAO,OAAO,CAAC,QAAQ,KAAK,QAAQ,CAAC;aACrC;SACD;QAED,gEAAgE;QAChE,iEAAiE;QACjE,6BAA6B;QAC7B,MAAM,EAAE,KAAK,EAAE,GAAG,IAAI,KAAK,EAAE,CAAC;QAC9B,IAAI,OAAO,KAAK,KAAK,QAAQ;YAAE,OAAO,KAAK,CAAC;QAC5C,OAAO,KAAK;aACV,KAAK,CAAC,IAAI,CAAC;aACX,IAAI,CACJ,CAAC,CAAC,EAAE,EAAE,CACL,CAAC,CAAC,OAAO,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC;YAC9B,CAAC,CAAC,OAAO,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC,CAChC,CAAC;IACJ,CAAC;IAED,wEAAwE;IACxE,2EAA2E;IAC3E,yEAAyE;IACzE,6EAA6E;IAC7E,kEAAkE;IAClE,sBAAsB;IACd,gBAAgB,CAAC,IAAY;QACpC,2EAA2E;QAC3E,yEAAyE;QACzE,yBAAyB;QACzB,IAAI,IAAI,CAAC,UAAU,KAAK,QAAQ,IAAI,IAAI,CAAC,eAAe,KAAK,QAAQ,EAAE;YACtE,OAAO,IAAI,CAAC;SACZ;QACD,iEAAiE;QACjE,wEAAwE;QACxE,qCAAqC;QACrC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE;YACxB,0DAA0D;YAC1D,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC;SACxB;QACD,MAAM,UAAU,GAAG,IAAI,GAAG,CAAC,MAAM,CAAC,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC,CAAC;QACtD,IAAI,CAAC,OAAO,CAAC,IAAI,CAAkB,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QACtD,qEAAqE;QACrE,IAAI,CAAC,gBAAgB,EAAE,CAAC;QACxB,OAAO,UAAU,CAAC;IACnB,CAAC;IAEO,gBAAgB,CAAC,IAAY,EAAE,MAAyB;QAC/D,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,MAAM,KAAK,IAAI,EAAE;YAC3C,OAAO;SACP;QACD,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAiB,CAAC;QACnD,MAAM,KAAK,GAAG,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;QACtC,IAAI,KAAK,KAAK,CAAC,CAAC,EAAE;YACjB,OAAO,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;YACzB,sEAAsE;YACtE,IAAI,CAAC,gBAAgB,EAAE,CAAC;YACxB,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC,EAAE;gBACzB,0DAA0D;gBAC1D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;aAC1B;SACD;IACF,CAAC;IAED,8EAA8E;IAC9E,oDAAoD;IACpD,OAAO,CAAC,OAAyB;QAChC,MAAM,cAAc,GACnB,OAAO,OAAO,CAAC,cAAc,KAAK,SAAS;YAC1C,CAAC,CAAC,OAAO,CAAC,cAAc;YACxB,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;QACnC,IAAI,cAAc,EAAE;YACnB,8DAA8D;YAC9D,OAAO,aAAU,CAAC,SAAS,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;SACxD;QACD,8DAA8D;QAC9D,OAAO,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;IAC/B,CAAC;IAED,YAAY,CACX,GAAuB,EACvB,OAAyB,EACzB,EAA2C;QAE3C,MAAM,WAAW,GAAG;YACnB,GAAG,OAAO;YACV,cAAc,EAAE,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC;SAC9C,CAAC;QACF,MAAM,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;QACvC,MAAM,UAAU,GAAG,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC;QAC/C,OAAO,CAAC,OAAO,EAAE;aACf,IAAI,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,WAAW,CAAC,CAAC;aAC1C,IAAI,CACJ,CAAC,MAAM,EAAE,EAAE;YACV,IAAI,CAAC,gBAAgB,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;YACxC,IAAI,MAAM,YAAY,IAAI,CAAC,KAAK,EAAE;gBACjC,IAAI;oBACH,iEAAiE;oBACjE,OAAO,MAAM,CAAC,UAAU,CAAC,GAAG,EAAE,WAAW,CAAC,CAAC;iBAC3C;gBAAC,OAAO,GAAY,EAAE;oBACtB,OAAO,EAAE,CAAC,GAAY,CAAC,CAAC;iBACxB;aACD;YACD,IAAI,CAAC,QAAQ,CAAC,CAAC,aAAa,GAAG,MAAM,CAAC;YACtC,mEAAmE;YACnE,KAAK,CAAC,YAAY,CAAC,GAAG,EAAE,OAAO,EAAE,EAAE,CAAC,CAAC;QACtC,CAAC,EACD,CAAC,GAAG,EAAE,EAAE;YACP,IAAI,CAAC,gBAAgB,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;YACxC,EAAE,CAAC,GAAG,CAAC,CAAC;QACT,CAAC,CACD,CAAC;IACJ,CAAC;IAED,gBAAgB;QACf,MAAM,MAAM,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAC,aAAa,CAAC;QAC5C,IAAI,CAAC,QAAQ,CAAC,CAAC,aAAa,GAAG,SAAS,CAAC;QACzC,IAAI,CAAC,MAAM,EAAE;YACZ,MAAM,IAAI,KAAK,CACd,oDAAoD,CACpD,CAAC;SACF;QACD,OAAO,MAAM,CAAC;IACf,CAAC;IAED,IAAI,WAAW;QACd,OAAO,CACN,IAAI,CAAC,QAAQ,CAAC,CAAC,WAAW;YAC1B,CAAC,IAAI,CAAC,QAAQ,KAAK,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CACvC,CAAC;IACH,CAAC;IAED,IAAI,WAAW,CAAC,CAAS;QACxB,IAAI,IAAI,CAAC,QAAQ,CAAC,EAAE;YACnB,IAAI,CAAC,QAAQ,CAAC,CAAC,WAAW,GAAG,CAAC,CAAC;SAC/B;IACF,CAAC;IAED,IAAI,QAAQ;QACX,OAAO,CACN,IAAI,CAAC,QAAQ,CAAC,CAAC,QAAQ;YACvB,CAAC,IAAI,CAAC,gBAAgB,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,CAC9C,CAAC;IACH,CAAC;IAED,IAAI,QAAQ,CAAC,CAAS;QACrB,IAAI,IAAI,CAAC,QAAQ,CAAC,EAAE;YACnB,IAAI,CAAC,QAAQ,CAAC,CAAC,QAAQ,GAAG,CAAC,CAAC;SAC5B;IACF,CAAC;CACD;AArLD,sBAqLC"} \ No newline at end of file diff --git a/node_modules/agent-base/package.json b/node_modules/agent-base/package.json index 8e951717..175ee71f 100644 --- a/node_modules/agent-base/package.json +++ b/node_modules/agent-base/package.json @@ -1,6 +1,6 @@ { "name": "agent-base", - "version": "7.1.1", + "version": "7.1.3", "description": "Turn a function into an `http.Agent` instance", "main": "./dist/index.js", "types": "./dist/index.d.ts", @@ -21,9 +21,6 @@ ], "author": "Nathan Rajlich (http://n8.io/)", "license": "MIT", - "dependencies": { - "debug": "^4.3.4" - }, "devDependencies": { "@types/debug": "^4.1.7", "@types/jest": "^29.5.1", @@ -34,7 +31,7 @@ "jest": "^29.5.0", "ts-jest": "^29.1.0", "typescript": "^5.0.4", - "ws": "^3.3.3", + "ws": "^5.2.4", "tsconfig": "0.0.0" }, "engines": { diff --git a/node_modules/bare-events/README.md b/node_modules/bare-events/README.md index f6529aa5..f56b4593 100644 --- a/node_modules/bare-events/README.md +++ b/node_modules/bare-events/README.md @@ -8,7 +8,7 @@ npm install bare-events ## Usage -``` js +```js const EventEmitter = require('bare-events') const e = new EventEmitter() diff --git a/node_modules/bare-events/index.d.ts b/node_modules/bare-events/index.d.ts new file mode 100644 index 00000000..69dae838 --- /dev/null +++ b/node_modules/bare-events/index.d.ts @@ -0,0 +1,91 @@ +declare interface EventMap { + [event: string | symbol]: unknown[] +} + +declare interface EventHandler< + in A extends unknown[] = unknown[], + out R = unknown +> { + (...args: A): R +} + +declare class EventEmitterError extends Error { + static OPERATION_ABORTED(cause: Error, msg?: string): EventEmitterError + static UNHANDLED_ERROR(cause: Error, msg?: string): EventEmitterError +} + +declare interface EventEmitter { + addListener(name: E, fn: EventHandler): this + + addOnceListener( + name: E, + fn: EventHandler + ): this + + prependListener( + name: E, + fn: EventHandler + ): this + + prependOnceListener( + name: E, + fn: EventHandler + ): this + + removeListener(name: E, fn: EventHandler): this + + removeAllListeners(name?: E): this + + on(name: E, fn: EventHandler): this + + once(name: E, fn: EventHandler): this + + off(name: E, fn: EventHandler): this + + emit(name: E, ...args: M[E]): boolean + + listeners(name: E): EventHandler + + listenerCount(name: E): number + + getMaxListeners(): number + setMaxListeners(n: number): void +} + +declare class EventEmitter {} + +declare namespace EventEmitter { + export function on( + emitter: EventEmitter, + name: E, + opts?: { signal?: AbortSignal } + ): AsyncIterableIterator + + export function once( + emitter: EventEmitter, + name: E, + opts?: { signal?: AbortSignal } + ): Promise + + export function forward< + F extends EventMap, + E extends keyof F, + T extends Pick + >( + from: EventEmitter, + to: EventEmitter, + names: E | E[], + opts?: { emit?: (name: E, ...args: T[E]) => void } + ): void + + export function listenerCount( + emitter: EventEmitter, + name: E + ): number + + export let defaultMaxListeners: number + + export { EventEmitter, EventEmitterError as errors, EventMap, EventHandler } +} + +export = EventEmitter diff --git a/node_modules/bare-events/index.js b/node_modules/bare-events/index.js index 2f7cb0a5..3e52e5a2 100644 --- a/node_modules/bare-events/index.js +++ b/node_modules/bare-events/index.js @@ -1,24 +1,24 @@ const errors = require('./lib/errors') class EventListener { - constructor () { + constructor() { this.list = [] this.count = 0 } - append (ctx, name, fn, once) { + append(ctx, name, fn, once) { this.count++ ctx.emit('newListener', name, fn) // Emit BEFORE adding this.list.push([fn, once]) } - prepend (ctx, name, fn, once) { + prepend(ctx, name, fn, once) { this.count++ ctx.emit('newListener', name, fn) // Emit BEFORE adding this.list.unshift([fn, once]) } - remove (ctx, name, fn) { + remove(ctx, name, fn) { for (let i = 0, n = this.list.length; i < n; i++) { const l = this.list[i] @@ -35,7 +35,7 @@ class EventListener { } } - removeAll (ctx, name) { + removeAll(ctx, name) { const list = [...this.list] this.list = [] @@ -48,7 +48,7 @@ class EventListener { this.count -= list.length } - emit (ctx, name, ...args) { + emit(ctx, name, ...args) { const list = [...this.list] for (let i = 0, n = list.length; i < n; i++) { @@ -63,25 +63,25 @@ class EventListener { } } -function appendListener (ctx, name, fn, once) { +function appendListener(ctx, name, fn, once) { const e = ctx._events[name] || (ctx._events[name] = new EventListener()) e.append(ctx, name, fn, once) return ctx } -function prependListener (ctx, name, fn, once) { +function prependListener(ctx, name, fn, once) { const e = ctx._events[name] || (ctx._events[name] = new EventListener()) e.prepend(ctx, name, fn, once) return ctx } -function removeListener (ctx, name, fn) { +function removeListener(ctx, name, fn) { const e = ctx._events[name] if (e !== undefined) e.remove(ctx, name, fn) return ctx } -function throwUnhandledError (...args) { +function throwUnhandledError(...args) { let err if (args.length > 0) err = args[0] @@ -92,69 +92,74 @@ function throwUnhandledError (...args) { Error.captureStackTrace(err, exports.prototype.emit) } - queueMicrotask(() => { throw err }) + queueMicrotask(() => { + throw err + }) } module.exports = exports = class EventEmitter { - constructor () { + constructor() { this._events = Object.create(null) } - addListener (name, fn) { + addListener(name, fn) { return appendListener(this, name, fn, false) } - addOnceListener (name, fn) { + addOnceListener(name, fn) { return appendListener(this, name, fn, true) } - prependListener (name, fn) { + prependListener(name, fn) { return prependListener(this, name, fn, false) } - prependOnceListener (name, fn) { + prependOnceListener(name, fn) { return prependListener(this, name, fn, true) } - removeListener (name, fn) { + removeListener(name, fn) { return removeListener(this, name, fn) } - on (name, fn) { + on(name, fn) { return appendListener(this, name, fn, false) } - once (name, fn) { + once(name, fn) { return appendListener(this, name, fn, true) } - off (name, fn) { + off(name, fn) { return removeListener(this, name, fn) } - emit (name, ...args) { - if (name === 'error' && this._events.error === undefined) throwUnhandledError(...args) + emit(name, ...args) { + if (name === 'error' && this._events.error === undefined) { + throwUnhandledError(...args) + } + const e = this._events[name] return e === undefined ? false : e.emit(this, name, ...args) } - listeners (name) { + listeners(name) { const e = this._events[name] return e === undefined ? [] : [...e.list] } - listenerCount (name) { + listenerCount(name) { const e = this._events[name] return e === undefined ? 0 : e.list.length } - getMaxListeners () { + getMaxListeners() { return EventEmitter.defaultMaxListeners } - setMaxListeners (n) {} + setMaxListeners(n) {} - removeAllListeners (name) { + removeAllListeners(name) { if (arguments.length === 0) { for (const key of Reflect.ownKeys(this._events)) { if (key === 'removeListener') continue @@ -175,10 +180,8 @@ exports.errors = errors exports.defaultMaxListeners = 10 -exports.on = function on (emitter, name, opts = {}) { - const { - signal - } = opts +exports.on = function on(emitter, name, opts = {}) { + const { signal } = opts if (signal && signal.aborted) { throw errors.OPERATION_ABORTED(signal.reason) @@ -197,7 +200,7 @@ exports.on = function on (emitter, name, opts = {}) { if (signal) signal.addEventListener('abort', onabort) return { - next () { + next() { if (events.length) { return Promise.resolve({ value: events.shift(), done: false }) } @@ -217,20 +220,20 @@ exports.on = function on (emitter, name, opts = {}) { ) }, - return () { + return() { return onclose() }, - throw (err) { + throw(err) { return onerror(err) }, - [Symbol.asyncIterator] () { + [Symbol.asyncIterator]() { return this } } - function onevent (...args) { + function onevent(...args) { if (promises.length) { promises.shift().resolve({ value: args, done: false }) } else { @@ -238,7 +241,7 @@ exports.on = function on (emitter, name, opts = {}) { } } - function onerror (err) { + function onerror(err) { if (promises.length) { promises.shift().reject(err) } else { @@ -248,11 +251,11 @@ exports.on = function on (emitter, name, opts = {}) { return Promise.resolve({ done: true }) } - function onabort () { + function onabort() { onerror(errors.OPERATION_ABORTED(signal.reason)) } - function onclose () { + function onclose() { emitter.off(name, onevent) if (name !== 'error') emitter.off('error', onerror) @@ -267,10 +270,8 @@ exports.on = function on (emitter, name, opts = {}) { } } -exports.once = function once (emitter, name, opts = {}) { - const { - signal - } = opts +exports.once = function once(emitter, name, opts = {}) { + const { signal } = opts if (signal && signal.aborted) { throw errors.OPERATION_ABORTED(signal.reason) @@ -289,13 +290,13 @@ exports.once = function once (emitter, name, opts = {}) { resolve(args) }) - function onerror (err) { + function onerror(err) { emitter.off('error', onerror) reject(err) } - function onabort () { + function onabort() { signal.removeEventListener('abort', onabort) onerror(errors.OPERATION_ABORTED(signal.reason)) @@ -303,34 +304,33 @@ exports.once = function once (emitter, name, opts = {}) { }) } -exports.forward = function forward (from, to, names, opts = {}) { +exports.forward = function forward(from, to, names, opts = {}) { if (typeof names === 'string') names = [names] - const { - emit = to.emit.bind(to) - } = opts + const { emit = to.emit.bind(to) } = opts - const listeners = names.map((name) => function onevent (...args) { - emit(name, ...args) - }) + const listeners = names.map( + (name) => + function onevent(...args) { + emit(name, ...args) + } + ) - to - .on('newListener', (name) => { - const i = names.indexOf(name) + to.on('newListener', (name) => { + const i = names.indexOf(name) - if (i !== -1 && to.listenerCount(name) === 0) { - from.on(name, listeners[i]) - } - }) - .on('removeListener', (name) => { - const i = names.indexOf(name) + if (i !== -1 && to.listenerCount(name) === 0) { + from.on(name, listeners[i]) + } + }).on('removeListener', (name) => { + const i = names.indexOf(name) - if (i !== -1 && to.listenerCount(name) === 0) { - from.off(name, listeners[i]) - } - }) + if (i !== -1 && to.listenerCount(name) === 0) { + from.off(name, listeners[i]) + } + }) } -exports.listenerCount = function listenerCount (emitter, name) { +exports.listenerCount = function listenerCount(emitter, name) { return emitter.listenerCount(name) } diff --git a/node_modules/bare-events/lib/errors.js b/node_modules/bare-events/lib/errors.js index 2b791155..a708f29f 100644 --- a/node_modules/bare-events/lib/errors.js +++ b/node_modules/bare-events/lib/errors.js @@ -1,5 +1,5 @@ module.exports = class EventEmitterError extends Error { - constructor (msg, code, fn = EventEmitterError, opts) { + constructor(msg, code, fn = EventEmitterError, opts) { super(`${code}: ${msg}`, opts) this.code = code @@ -8,15 +8,25 @@ module.exports = class EventEmitterError extends Error { } } - get name () { + get name() { return 'EventEmitterError' } - static OPERATION_ABORTED (cause, msg = 'Operation aborted') { - return new EventEmitterError(msg, 'OPERATION_ABORTED', EventEmitterError.OPERATION_ABORTED, { cause }) + static OPERATION_ABORTED(cause, msg = 'Operation aborted') { + return new EventEmitterError( + msg, + 'OPERATION_ABORTED', + EventEmitterError.OPERATION_ABORTED, + { cause } + ) } - static UNHANDLED_ERROR (cause, msg = 'Unhandled error') { - return new EventEmitterError(msg, 'UNHANDLED_ERROR', EventEmitterError.UNHANDLED_ERROR, { cause }) + static UNHANDLED_ERROR(cause, msg = 'Unhandled error') { + return new EventEmitterError( + msg, + 'UNHANDLED_ERROR', + EventEmitterError.UNHANDLED_ERROR, + { cause } + ) } } diff --git a/node_modules/bare-events/package.json b/node_modules/bare-events/package.json index 95d22d9a..1652e213 100644 --- a/node_modules/bare-events/package.json +++ b/node_modules/bare-events/package.json @@ -1,21 +1,25 @@ { "name": "bare-events", - "version": "2.5.0", + "version": "2.5.4", "description": "Event emitters for JavaScript", "exports": { - ".": "./index.js", + ".": { + "types": "./index.d.ts", + "default": "./index.js" + }, "./package": "./package.json", "./errors": "./lib/errors.js" }, "files": [ "index.js", + "index.d.ts", "lib" ], "scripts": { "test": "npm run lint && npm run test:bare && npm run test:node", "test:bare": "bare test.js", "test:node": "node test.js", - "lint": "standard" + "lint": "prettier . --check" }, "repository": { "type": "git", @@ -29,6 +33,7 @@ "homepage": "https://github.com/holepunchto/bare-events#readme", "devDependencies": { "brittle": "^3.3.2", - "standard": "^17.0.0" + "prettier": "^3.4.2", + "prettier-config-standard": "^7.0.0" } } diff --git a/node_modules/debug/package.json b/node_modules/debug/package.json index 2f782eb9..60dfcf57 100644 --- a/node_modules/debug/package.json +++ b/node_modules/debug/package.json @@ -1,6 +1,6 @@ { "name": "debug", - "version": "4.3.7", + "version": "4.4.0", "repository": { "type": "git", "url": "git://github.com/debug-js/debug.git" @@ -56,5 +56,10 @@ "browser": "./src/browser.js", "engines": { "node": ">=6.0" + }, + "xo": { + "rules": { + "import/extensions": "off" + } } } diff --git a/node_modules/debug/src/browser.js b/node_modules/debug/src/browser.js index 8d808e58..df8e179e 100644 --- a/node_modules/debug/src/browser.js +++ b/node_modules/debug/src/browser.js @@ -129,6 +129,7 @@ function useColors() { // Is webkit? http://stackoverflow.com/a/16459606/376773 // document is undefined in react-native: https://github.com/facebook/react-native/pull/1632 + // eslint-disable-next-line no-return-assign return (typeof document !== 'undefined' && document.documentElement && document.documentElement.style && document.documentElement.style.WebkitAppearance) || // Is firebug? http://stackoverflow.com/a/398120/376773 (typeof window !== 'undefined' && window.console && (window.console.firebug || (window.console.exception && window.console.table))) || diff --git a/node_modules/debug/src/common.js b/node_modules/debug/src/common.js index e3291b20..528c7ecf 100644 --- a/node_modules/debug/src/common.js +++ b/node_modules/debug/src/common.js @@ -166,24 +166,62 @@ function setup(env) { createDebug.names = []; createDebug.skips = []; - let i; - const split = (typeof namespaces === 'string' ? namespaces : '').split(/[\s,]+/); - const len = split.length; - - for (i = 0; i < len; i++) { - if (!split[i]) { - // ignore empty strings - continue; + const split = (typeof namespaces === 'string' ? namespaces : '') + .trim() + .replace(' ', ',') + .split(',') + .filter(Boolean); + + for (const ns of split) { + if (ns[0] === '-') { + createDebug.skips.push(ns.slice(1)); + } else { + createDebug.names.push(ns); } + } + } - namespaces = split[i].replace(/\*/g, '.*?'); - - if (namespaces[0] === '-') { - createDebug.skips.push(new RegExp('^' + namespaces.slice(1) + '$')); + /** + * Checks if the given string matches a namespace template, honoring + * asterisks as wildcards. + * + * @param {String} search + * @param {String} template + * @return {Boolean} + */ + function matchesTemplate(search, template) { + let searchIndex = 0; + let templateIndex = 0; + let starIndex = -1; + let matchIndex = 0; + + while (searchIndex < search.length) { + if (templateIndex < template.length && (template[templateIndex] === search[searchIndex] || template[templateIndex] === '*')) { + // Match character or proceed with wildcard + if (template[templateIndex] === '*') { + starIndex = templateIndex; + matchIndex = searchIndex; + templateIndex++; // Skip the '*' + } else { + searchIndex++; + templateIndex++; + } + } else if (starIndex !== -1) { // eslint-disable-line no-negated-condition + // Backtrack to the last '*' and try to match more characters + templateIndex = starIndex + 1; + matchIndex++; + searchIndex = matchIndex; } else { - createDebug.names.push(new RegExp('^' + namespaces + '$')); + return false; // No match } } + + // Handle trailing '*' in template + while (templateIndex < template.length && template[templateIndex] === '*') { + templateIndex++; + } + + return templateIndex === template.length; } /** @@ -194,8 +232,8 @@ function setup(env) { */ function disable() { const namespaces = [ - ...createDebug.names.map(toNamespace), - ...createDebug.skips.map(toNamespace).map(namespace => '-' + namespace) + ...createDebug.names, + ...createDebug.skips.map(namespace => '-' + namespace) ].join(','); createDebug.enable(''); return namespaces; @@ -209,21 +247,14 @@ function setup(env) { * @api public */ function enabled(name) { - if (name[name.length - 1] === '*') { - return true; - } - - let i; - let len; - - for (i = 0, len = createDebug.skips.length; i < len; i++) { - if (createDebug.skips[i].test(name)) { + for (const skip of createDebug.skips) { + if (matchesTemplate(name, skip)) { return false; } } - for (i = 0, len = createDebug.names.length; i < len; i++) { - if (createDebug.names[i].test(name)) { + for (const ns of createDebug.names) { + if (matchesTemplate(name, ns)) { return true; } } @@ -231,19 +262,6 @@ function setup(env) { return false; } - /** - * Convert regexp to namespace - * - * @param {RegExp} regxep - * @return {String} namespace - * @api private - */ - function toNamespace(regexp) { - return regexp.toString() - .substring(2, regexp.toString().length - 2) - .replace(/\.\*\?$/, '*'); - } - /** * Coerce `val`. * diff --git a/node_modules/fast-xml-parser/CHANGELOG.md b/node_modules/fast-xml-parser/CHANGELOG.md index 4250d26f..4c10fbfb 100644 --- a/node_modules/fast-xml-parser/CHANGELOG.md +++ b/node_modules/fast-xml-parser/CHANGELOG.md @@ -1,5 +1,9 @@ Note: If you find missing information about particular minor version, that version must have been changed without any functional change in this library. +**4.5.1 / 2024-12-15** +- Fix empty tag key name for v5 (#697). no impact on v4 +- Fixes entity parsing when used in strict mode (#699) + **4.5.0 / 2024-09-03** - feat #666: ignoreAttributes support function, and array of string or regex (By [ArtemM](https://github.com/mav-rik)) diff --git a/node_modules/fast-xml-parser/README.md b/node_modules/fast-xml-parser/README.md index 18918389..fd22f583 100644 --- a/node_modules/fast-xml-parser/README.md +++ b/node_modules/fast-xml-parser/README.md @@ -21,7 +21,7 @@ Sponsor this project - Stubmatic donate button + donate button


@@ -50,7 +50,8 @@ Through OpenCollective --> -![fxp_sponsors](https://github.com/NaturalIntelligence/fast-xml-parser/assets/7692328/c9367497-d67e-410a-90a6-66e3808be929) +![fxp_sponsors](https://raw.githubusercontent.com/NaturalIntelligence/ThankYouBackers/main/assets/NI_sponsors.jpg) +Hiroki Kokubun ## Users diff --git a/node_modules/fast-xml-parser/package.json b/node_modules/fast-xml-parser/package.json index f2402c92..9a54c7b9 100644 --- a/node_modules/fast-xml-parser/package.json +++ b/node_modules/fast-xml-parser/package.json @@ -1,6 +1,6 @@ { "name": "fast-xml-parser", - "version": "4.5.0", + "version": "4.5.1", "description": "Validate XML, Parse XML, Build XML without C/C++ based libraries", "main": "./src/fxp.js", "scripts": { diff --git a/node_modules/fast-xml-parser/src/v5/XmlPartReader.js b/node_modules/fast-xml-parser/src/v5/XmlPartReader.js index 56b180e9..b77fb68d 100644 --- a/node_modules/fast-xml-parser/src/v5/XmlPartReader.js +++ b/node_modules/fast-xml-parser/src/v5/XmlPartReader.js @@ -2,17 +2,17 @@ /** * find paired tag for a stop node - * @param {string} xmlDoc - * @param {string} tagName + * @param {string} xmlDoc + * @param {string} tagName * @param {number} i : start index */ function readStopNode(xmlDoc, tagName, i){ const startIndex = i; // Starting at 1 since we already have an open tag let openTagCount = 1; - + for (; i < xmlDoc.length; i++) { - if( xmlDoc[i] === "<"){ + if( xmlDoc[i] === "<"){ if (xmlDoc[i+1] === "/") {//close tag const closeIndex = findSubStrIndex(xmlDoc, ">", i, `${tagName} is not closed`); let closeTagName = xmlDoc.substring(i+2,closeIndex).trim(); @@ -26,18 +26,18 @@ function readStopNode(xmlDoc, tagName, i){ } } i=closeIndex; - } else if(xmlDoc[i+1] === '?') { + } else if(xmlDoc[i+1] === '?') { const closeIndex = findSubStrIndex(xmlDoc, "?>", i+1, "StopNode is not closed.") i=closeIndex; - } else if(xmlDoc.substr(i + 1, 3) === '!--') { + } else if(xmlDoc.substr(i + 1, 3) === '!--') { const closeIndex = findSubStrIndex(xmlDoc, "-->", i+3, "StopNode is not closed.") i=closeIndex; - } else if(xmlDoc.substr(i + 1, 2) === '![') { + } else if(xmlDoc.substr(i + 1, 2) === '![') { const closeIndex = findSubStrIndex(xmlDoc, "]]>", i, "StopNode is not closed.") - 2; i=closeIndex; } else { const tagData = readTagExp(xmlDoc, i, '>') - + if (tagData) { const openTagName = tagData && tagData.tagName; if (openTagName === tagName && tagData.tagExp[tagData.tagExp.length-1] !== "/") { @@ -52,7 +52,7 @@ function readStopNode(xmlDoc, tagName, i){ /** * Read closing tag name - * @param {Source} source + * @param {Source} source * @returns tag name */ function readClosingTagName(source){ @@ -73,9 +73,9 @@ function readClosingTagName(source){ * This function can be used to read normal tag, pi tag. * This function can't be used to read comment, CDATA, DOCTYPE. * Eg - * @param {string} xmlDoc + * @param {string} xmlDoc * @param {number} startIndex starting index - * @returns tag expression includes tag name & attribute string + * @returns tag expression includes tag name & attribute string */ function readTagExp(parser) { let inSingleQuotes = false; @@ -100,8 +100,8 @@ function readTagExp(parser) { if(inSingleQuotes || inDoubleQuotes){ throw new Error("Invalid attribute expression. Quote is not properly closed"); }else if(!EOE) throw new Error("Unexpected closing of source. Waiting for '>'"); - - + + const exp = parser.source.readStr(i); parser.source.updateBufferBoundary(i + 1); return buildTagExpObj(exp, parser) @@ -133,7 +133,7 @@ function readPiExp(parser) { if(inSingleQuotes || inDoubleQuotes){ throw new Error("Invalid attribute expression. Quote is not properly closed in PI tag expression"); }else if(!EOE) throw new Error("Unexpected closing of source. Waiting for '?>'"); - + if(!parser.options.attributes.ignore){ //TODO: use regex to verify attributes if not set to ignore } @@ -150,7 +150,11 @@ function buildTagExpObj(exp, parser){ }; let attrsExp = ""; - if(exp[exp.length -1] === "/") tagExp.selfClosing = true; + // Check for self-closing tag before setting the name + if(exp[exp.length -1] === "/") { + tagExp.selfClosing = true; + exp = exp.slice(0, -1); // Remove the trailing slash + } //separate tag name let i = 0; @@ -182,7 +186,7 @@ function parseAttributesExp(attrStr, parser) { for (let i = 0; i < len; i++) { let attrName = parser.processAttrName(matches[i][1]); let attrVal = parser.replaceEntities(matches[i][4] || true); - + parser.outputBuilder.addAttribute(attrName, attrVal); } } @@ -209,4 +213,4 @@ module.exports = { readClosingTagName: readClosingTagName, readTagExp: readTagExp, readPiExp: readPiExp, -} \ No newline at end of file +} diff --git a/node_modules/fast-xml-parser/src/xmlparser/DocTypeReader.js b/node_modules/fast-xml-parser/src/xmlparser/DocTypeReader.js index bcf9dee4..bfde18e8 100644 --- a/node_modules/fast-xml-parser/src/xmlparser/DocTypeReader.js +++ b/node_modules/fast-xml-parser/src/xmlparser/DocTypeReader.js @@ -19,6 +19,7 @@ function readDocType(xmlData, i){ if (xmlData[i] === '<' && !comment) { //Determine the tag type if( hasBody && isEntity(xmlData, i)){ i += 7; + let entityName, val; [entityName, val,i] = readEntityExp(xmlData,i+1); if(val.indexOf("&") === -1) //Parameter entities are not supported entities[ validateEntityName(entityName) ] = { diff --git a/node_modules/https-proxy-agent/dist/index.d.ts.map b/node_modules/https-proxy-agent/dist/index.d.ts.map index 297f8cb4..c23c3a06 100644 --- a/node_modules/https-proxy-agent/dist/index.d.ts.map +++ b/node_modules/https-proxy-agent/dist/index.d.ts.map @@ -1 +1 @@ -{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;AAAA,OAAO,KAAK,GAAG,MAAM,KAAK,CAAC;AAC3B,OAAO,KAAK,GAAG,MAAM,KAAK,CAAC;AAC3B,OAAO,KAAK,IAAI,MAAM,MAAM,CAAC;AAG7B,OAAO,EAAE,KAAK,EAAE,gBAAgB,EAAE,MAAM,YAAY,CAAC;AACrD,OAAO,EAAE,GAAG,EAAE,MAAM,KAAK,CAAC;AAE1B,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,MAAM,CAAC;AAKhD,KAAK,QAAQ,CAAC,CAAC,IAAI,CAAC,SAAS,GAAG,MAAM,QAAQ,IAAI,MAAM,CAAC,EAAE,GAAG,QAAQ,GAAG,KAAK,CAAC;AAE/E,KAAK,cAAc,GAAG;IACrB,IAAI,EAAE,IAAI,CAAC,GAAG,CAAC,iBAAiB,EAAE,MAAM,GAAG,MAAM,CAAC,CAAC;IACnD,KAAK,EAAE,IAAI,CAAC,GAAG,CAAC,iBAAiB,EAAE,MAAM,GAAG,MAAM,CAAC,CAAC;CACpD,CAAC;AAEF,KAAK,WAAW,CAAC,CAAC,IAAI;KACpB,CAAC,IAAI,MAAM,cAAc,GAAG,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAC,GAC/C,cAAc,CAAC,CAAC,CAAC,GACjB,KAAK;CACR,CAAC,MAAM,cAAc,CAAC,CAAC;AAExB,MAAM,MAAM,sBAAsB,CAAC,CAAC,IAAI,WAAW,CAAC,CAAC,CAAC,GACrD,IAAI,CAAC,YAAY,GAAG;IACnB,OAAO,CAAC,EAAE,mBAAmB,GAAG,CAAC,MAAM,mBAAmB,CAAC,CAAC;CAC5D,CAAC;AAEH;;;;;;;;;;;GAWG;AACH,qBAAa,eAAe,CAAC,GAAG,SAAS,MAAM,CAAE,SAAQ,KAAK;IAC7D,MAAM,CAAC,SAAS,6BAA8B;IAE9C,QAAQ,CAAC,KAAK,EAAE,GAAG,CAAC;IACpB,YAAY,EAAE,mBAAmB,GAAG,CAAC,MAAM,mBAAmB,CAAC,CAAC;IAChE,WAAW,EAAE,GAAG,CAAC,iBAAiB,GAAG,GAAG,CAAC,iBAAiB,CAAC;gBAE/C,KAAK,EAAE,GAAG,GAAG,GAAG,EAAE,IAAI,CAAC,EAAE,sBAAsB,CAAC,GAAG,CAAC;IA0BhE;;;OAGG;IACG,OAAO,CACZ,GAAG,EAAE,IAAI,CAAC,aAAa,EACvB,IAAI,EAAE,gBAAgB,GACpB,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC;CA0GtB"} \ No newline at end of file +{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;AAAA,OAAO,KAAK,GAAG,MAAM,KAAK,CAAC;AAC3B,OAAO,KAAK,GAAG,MAAM,KAAK,CAAC;AAC3B,OAAO,KAAK,IAAI,MAAM,MAAM,CAAC;AAG7B,OAAO,EAAE,KAAK,EAAE,gBAAgB,EAAE,MAAM,YAAY,CAAC;AACrD,OAAO,EAAE,GAAG,EAAE,MAAM,KAAK,CAAC;AAE1B,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,MAAM,CAAC;AAuBhD,KAAK,QAAQ,CAAC,CAAC,IAAI,CAAC,SAAS,GAAG,MAAM,QAAQ,IAAI,MAAM,CAAC,EAAE,GAAG,QAAQ,GAAG,KAAK,CAAC;AAE/E,KAAK,cAAc,GAAG;IACrB,IAAI,EAAE,IAAI,CAAC,GAAG,CAAC,iBAAiB,EAAE,MAAM,GAAG,MAAM,CAAC,CAAC;IACnD,KAAK,EAAE,IAAI,CAAC,GAAG,CAAC,iBAAiB,EAAE,MAAM,GAAG,MAAM,CAAC,CAAC;CACpD,CAAC;AAEF,KAAK,WAAW,CAAC,CAAC,IAAI;KACpB,CAAC,IAAI,MAAM,cAAc,GAAG,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAC,GAC/C,cAAc,CAAC,CAAC,CAAC,GACjB,KAAK;CACR,CAAC,MAAM,cAAc,CAAC,CAAC;AAExB,MAAM,MAAM,sBAAsB,CAAC,CAAC,IAAI,WAAW,CAAC,CAAC,CAAC,GACrD,IAAI,CAAC,YAAY,GAAG;IACnB,OAAO,CAAC,EAAE,mBAAmB,GAAG,CAAC,MAAM,mBAAmB,CAAC,CAAC;CAC5D,CAAC;AAEH;;;;;;;;;;;GAWG;AACH,qBAAa,eAAe,CAAC,GAAG,SAAS,MAAM,CAAE,SAAQ,KAAK;IAC7D,MAAM,CAAC,SAAS,6BAA8B;IAE9C,QAAQ,CAAC,KAAK,EAAE,GAAG,CAAC;IACpB,YAAY,EAAE,mBAAmB,GAAG,CAAC,MAAM,mBAAmB,CAAC,CAAC;IAChE,WAAW,EAAE,GAAG,CAAC,iBAAiB,GAAG,GAAG,CAAC,iBAAiB,CAAC;gBAE/C,KAAK,EAAE,GAAG,GAAG,GAAG,EAAE,IAAI,CAAC,EAAE,sBAAsB,CAAC,GAAG,CAAC;IA0BhE;;;OAGG;IACG,OAAO,CACZ,GAAG,EAAE,IAAI,CAAC,aAAa,EACvB,IAAI,EAAE,gBAAgB,GACpB,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC;CAwGtB"} \ No newline at end of file diff --git a/node_modules/https-proxy-agent/dist/index.js b/node_modules/https-proxy-agent/dist/index.js index 0c917220..1857f464 100644 --- a/node_modules/https-proxy-agent/dist/index.js +++ b/node_modules/https-proxy-agent/dist/index.js @@ -35,6 +35,17 @@ const agent_base_1 = require("agent-base"); const url_1 = require("url"); const parse_proxy_response_1 = require("./parse-proxy-response"); const debug = (0, debug_1.default)('https-proxy-agent'); +const setServernameFromNonIpHost = (options) => { + if (options.servername === undefined && + options.host && + !net.isIP(options.host)) { + return { + ...options, + servername: options.host, + }; + } + return options; +}; /** * The `HttpsProxyAgent` implements an HTTP Agent subclass that connects to * the specified "HTTP(s) proxy server" in order to proxy HTTPS requests. @@ -82,11 +93,7 @@ class HttpsProxyAgent extends agent_base_1.Agent { let socket; if (proxy.protocol === 'https:') { debug('Creating `tls.Socket`: %o', this.connectOpts); - const servername = this.connectOpts.servername || this.connectOpts.host; - socket = tls.connect({ - ...this.connectOpts, - servername, - }); + socket = tls.connect(setServernameFromNonIpHost(this.connectOpts)); } else { debug('Creating `net.Socket`: %o', this.connectOpts); @@ -122,11 +129,9 @@ class HttpsProxyAgent extends agent_base_1.Agent { // The proxy is connecting to a TLS server, so upgrade // this socket connection to a TLS connection. debug('Upgrading socket connection to TLS'); - const servername = opts.servername || opts.host; return tls.connect({ - ...omit(opts, 'host', 'path', 'port'), + ...omit(setServernameFromNonIpHost(opts), 'host', 'path', 'port'), socket, - servername, }); } return socket; diff --git a/node_modules/https-proxy-agent/dist/index.js.map b/node_modules/https-proxy-agent/dist/index.js.map index 98370b22..ea7d2f31 100644 --- a/node_modules/https-proxy-agent/dist/index.js.map +++ b/node_modules/https-proxy-agent/dist/index.js.map @@ -1 +1 @@ -{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,yCAA2B;AAC3B,yCAA2B;AAE3B,oDAA4B;AAC5B,kDAAgC;AAChC,2CAAqD;AACrD,6BAA0B;AAC1B,iEAA4D;AAG5D,MAAM,KAAK,GAAG,IAAA,eAAW,EAAC,mBAAmB,CAAC,CAAC;AAqB/C;;;;;;;;;;;GAWG;AACH,MAAa,eAAoC,SAAQ,kBAAK;IAO7D,YAAY,KAAgB,EAAE,IAAkC;QAC/D,KAAK,CAAC,IAAI,CAAC,CAAC;QACZ,IAAI,CAAC,OAAO,GAAG,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC;QACnC,IAAI,CAAC,KAAK,GAAG,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,SAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;QAChE,IAAI,CAAC,YAAY,GAAG,IAAI,EAAE,OAAO,IAAI,EAAE,CAAC;QACxC,KAAK,CAAC,2CAA2C,EAAE,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAEpE,4CAA4C;QAC5C,MAAM,IAAI,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,IAAI,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,OAAO,CAC5D,UAAU,EACV,EAAE,CACF,CAAC;QACF,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI;YAC3B,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,EAAE,CAAC;YAC/B,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,KAAK,QAAQ;gBAClC,CAAC,CAAC,GAAG;gBACL,CAAC,CAAC,EAAE,CAAC;QACN,IAAI,CAAC,WAAW,GAAG;YAClB,sEAAsE;YACtE,aAAa,EAAE,CAAC,UAAU,CAAC;YAC3B,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;YACxC,IAAI;YACJ,IAAI;SACJ,CAAC;IACH,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,OAAO,CACZ,GAAuB,EACvB,IAAsB;QAEtB,MAAM,EAAE,KAAK,EAAE,GAAG,IAAI,CAAC;QAEvB,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE;YACf,MAAM,IAAI,SAAS,CAAC,oBAAoB,CAAC,CAAC;SAC1C;QAED,kDAAkD;QAClD,IAAI,MAAkB,CAAC;QACvB,IAAI,KAAK,CAAC,QAAQ,KAAK,QAAQ,EAAE;YAChC,KAAK,CAAC,2BAA2B,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;YACrD,MAAM,UAAU,GACf,IAAI,CAAC,WAAW,CAAC,UAAU,IAAI,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;YACtD,MAAM,GAAG,GAAG,CAAC,OAAO,CAAC;gBACpB,GAAG,IAAI,CAAC,WAAW;gBACnB,UAAU;aACV,CAAC,CAAC;SACH;aAAM;YACN,KAAK,CAAC,2BAA2B,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;YACrD,MAAM,GAAG,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;SACvC;QAED,MAAM,OAAO,GACZ,OAAO,IAAI,CAAC,YAAY,KAAK,UAAU;YACtC,CAAC,CAAC,IAAI,CAAC,YAAY,EAAE;YACrB,CAAC,CAAC,EAAE,GAAG,IAAI,CAAC,YAAY,EAAE,CAAC;QAC7B,MAAM,IAAI,GAAG,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,IAAI,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC;QAClE,IAAI,OAAO,GAAG,WAAW,IAAI,IAAI,IAAI,CAAC,IAAI,eAAe,CAAC;QAE1D,wDAAwD;QACxD,IAAI,KAAK,CAAC,QAAQ,IAAI,KAAK,CAAC,QAAQ,EAAE;YACrC,MAAM,IAAI,GAAG,GAAG,kBAAkB,CACjC,KAAK,CAAC,QAAQ,CACd,IAAI,kBAAkB,CAAC,KAAK,CAAC,QAAQ,CAAC,EAAE,CAAC;YAC1C,OAAO,CAAC,qBAAqB,CAAC,GAAG,SAAS,MAAM,CAAC,IAAI,CACpD,IAAI,CACJ,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC;SACvB;QAED,OAAO,CAAC,IAAI,GAAG,GAAG,IAAI,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC;QAEtC,IAAI,CAAC,OAAO,CAAC,kBAAkB,CAAC,EAAE;YACjC,OAAO,CAAC,kBAAkB,CAAC,GAAG,IAAI,CAAC,SAAS;gBAC3C,CAAC,CAAC,YAAY;gBACd,CAAC,CAAC,OAAO,CAAC;SACX;QACD,KAAK,MAAM,IAAI,IAAI,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE;YACxC,OAAO,IAAI,GAAG,IAAI,KAAK,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC;SAC3C;QAED,MAAM,oBAAoB,GAAG,IAAA,yCAAkB,EAAC,MAAM,CAAC,CAAC;QAExD,MAAM,CAAC,KAAK,CAAC,GAAG,OAAO,MAAM,CAAC,CAAC;QAE/B,MAAM,EAAE,OAAO,EAAE,QAAQ,EAAE,GAAG,MAAM,oBAAoB,CAAC;QACzD,GAAG,CAAC,IAAI,CAAC,cAAc,EAAE,OAAO,CAAC,CAAC;QAClC,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE,OAAO,EAAE,GAAG,CAAC,CAAC;QAExC,IAAI,OAAO,CAAC,UAAU,KAAK,GAAG,EAAE;YAC/B,GAAG,CAAC,IAAI,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;YAE3B,IAAI,IAAI,CAAC,cAAc,EAAE;gBACxB,sDAAsD;gBACtD,8CAA8C;gBAC9C,KAAK,CAAC,oCAAoC,CAAC,CAAC;gBAC5C,MAAM,UAAU,GAAG,IAAI,CAAC,UAAU,IAAI,IAAI,CAAC,IAAI,CAAC;gBAChD,OAAO,GAAG,CAAC,OAAO,CAAC;oBAClB,GAAG,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC;oBACrC,MAAM;oBACN,UAAU;iBACV,CAAC,CAAC;aACH;YAED,OAAO,MAAM,CAAC;SACd;QAED,oEAAoE;QACpE,kEAAkE;QAClE,iEAAiE;QACjE,qBAAqB;QAErB,iEAAiE;QACjE,0DAA0D;QAC1D,oEAAoE;QACpE,mBAAmB;QACnB,EAAE;QACF,4CAA4C;QAC5C,MAAM,CAAC,OAAO,EAAE,CAAC;QAEjB,MAAM,UAAU,GAAG,IAAI,GAAG,CAAC,MAAM,CAAC,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC,CAAC;QACvD,UAAU,CAAC,QAAQ,GAAG,IAAI,CAAC;QAE3B,oEAAoE;QACpE,GAAG,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAa,EAAE,EAAE;YACpC,KAAK,CAAC,2CAA2C,CAAC,CAAC;YACnD,IAAA,gBAAM,EAAC,CAAC,CAAC,aAAa,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC;YAEpC,gEAAgE;YAChE,8DAA8D;YAC9D,YAAY;YACZ,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;YACjB,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACd,CAAC,CAAC,CAAC;QAEH,OAAO,UAAU,CAAC;IACnB,CAAC;;AAhJM,yBAAS,GAAG,CAAC,MAAM,EAAE,OAAO,CAAU,CAAC;AADlC,0CAAe;AAoJ5B,SAAS,MAAM,CAAC,MAAkC;IACjD,MAAM,CAAC,MAAM,EAAE,CAAC;AACjB,CAAC;AAED,SAAS,IAAI,CACZ,GAAM,EACN,GAAG,IAAO;IAIV,MAAM,GAAG,GAAG,EAEX,CAAC;IACF,IAAI,GAAqB,CAAC;IAC1B,KAAK,GAAG,IAAI,GAAG,EAAE;QAChB,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE;YACxB,GAAG,CAAC,GAAG,CAAC,GAAG,GAAG,CAAC,GAAG,CAAC,CAAC;SACpB;KACD;IACD,OAAO,GAAG,CAAC;AACZ,CAAC"} \ No newline at end of file +{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,yCAA2B;AAC3B,yCAA2B;AAE3B,oDAA4B;AAC5B,kDAAgC;AAChC,2CAAqD;AACrD,6BAA0B;AAC1B,iEAA4D;AAG5D,MAAM,KAAK,GAAG,IAAA,eAAW,EAAC,mBAAmB,CAAC,CAAC;AAE/C,MAAM,0BAA0B,GAAG,CAGlC,OAAU,EACT,EAAE;IACH,IACC,OAAO,CAAC,UAAU,KAAK,SAAS;QAChC,OAAO,CAAC,IAAI;QACZ,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,EACtB;QACD,OAAO;YACN,GAAG,OAAO;YACV,UAAU,EAAE,OAAO,CAAC,IAAI;SACxB,CAAC;KACF;IACD,OAAO,OAAO,CAAC;AAChB,CAAC,CAAC;AAqBF;;;;;;;;;;;GAWG;AACH,MAAa,eAAoC,SAAQ,kBAAK;IAO7D,YAAY,KAAgB,EAAE,IAAkC;QAC/D,KAAK,CAAC,IAAI,CAAC,CAAC;QACZ,IAAI,CAAC,OAAO,GAAG,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC;QACnC,IAAI,CAAC,KAAK,GAAG,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,SAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;QAChE,IAAI,CAAC,YAAY,GAAG,IAAI,EAAE,OAAO,IAAI,EAAE,CAAC;QACxC,KAAK,CAAC,2CAA2C,EAAE,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAEpE,4CAA4C;QAC5C,MAAM,IAAI,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,IAAI,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,OAAO,CAC5D,UAAU,EACV,EAAE,CACF,CAAC;QACF,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI;YAC3B,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,EAAE,CAAC;YAC/B,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,KAAK,QAAQ;gBAClC,CAAC,CAAC,GAAG;gBACL,CAAC,CAAC,EAAE,CAAC;QACN,IAAI,CAAC,WAAW,GAAG;YAClB,sEAAsE;YACtE,aAAa,EAAE,CAAC,UAAU,CAAC;YAC3B,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;YACxC,IAAI;YACJ,IAAI;SACJ,CAAC;IACH,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,OAAO,CACZ,GAAuB,EACvB,IAAsB;QAEtB,MAAM,EAAE,KAAK,EAAE,GAAG,IAAI,CAAC;QAEvB,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE;YACf,MAAM,IAAI,SAAS,CAAC,oBAAoB,CAAC,CAAC;SAC1C;QAED,kDAAkD;QAClD,IAAI,MAAkB,CAAC;QACvB,IAAI,KAAK,CAAC,QAAQ,KAAK,QAAQ,EAAE;YAChC,KAAK,CAAC,2BAA2B,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;YACrD,MAAM,GAAG,GAAG,CAAC,OAAO,CAAC,0BAA0B,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC;SACnE;aAAM;YACN,KAAK,CAAC,2BAA2B,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;YACrD,MAAM,GAAG,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;SACvC;QAED,MAAM,OAAO,GACZ,OAAO,IAAI,CAAC,YAAY,KAAK,UAAU;YACtC,CAAC,CAAC,IAAI,CAAC,YAAY,EAAE;YACrB,CAAC,CAAC,EAAE,GAAG,IAAI,CAAC,YAAY,EAAE,CAAC;QAC7B,MAAM,IAAI,GAAG,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,IAAI,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC;QAClE,IAAI,OAAO,GAAG,WAAW,IAAI,IAAI,IAAI,CAAC,IAAI,eAAe,CAAC;QAE1D,wDAAwD;QACxD,IAAI,KAAK,CAAC,QAAQ,IAAI,KAAK,CAAC,QAAQ,EAAE;YACrC,MAAM,IAAI,GAAG,GAAG,kBAAkB,CACjC,KAAK,CAAC,QAAQ,CACd,IAAI,kBAAkB,CAAC,KAAK,CAAC,QAAQ,CAAC,EAAE,CAAC;YAC1C,OAAO,CAAC,qBAAqB,CAAC,GAAG,SAAS,MAAM,CAAC,IAAI,CACpD,IAAI,CACJ,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC;SACvB;QAED,OAAO,CAAC,IAAI,GAAG,GAAG,IAAI,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC;QAEtC,IAAI,CAAC,OAAO,CAAC,kBAAkB,CAAC,EAAE;YACjC,OAAO,CAAC,kBAAkB,CAAC,GAAG,IAAI,CAAC,SAAS;gBAC3C,CAAC,CAAC,YAAY;gBACd,CAAC,CAAC,OAAO,CAAC;SACX;QACD,KAAK,MAAM,IAAI,IAAI,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE;YACxC,OAAO,IAAI,GAAG,IAAI,KAAK,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC;SAC3C;QAED,MAAM,oBAAoB,GAAG,IAAA,yCAAkB,EAAC,MAAM,CAAC,CAAC;QAExD,MAAM,CAAC,KAAK,CAAC,GAAG,OAAO,MAAM,CAAC,CAAC;QAE/B,MAAM,EAAE,OAAO,EAAE,QAAQ,EAAE,GAAG,MAAM,oBAAoB,CAAC;QACzD,GAAG,CAAC,IAAI,CAAC,cAAc,EAAE,OAAO,CAAC,CAAC;QAClC,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE,OAAO,EAAE,GAAG,CAAC,CAAC;QAExC,IAAI,OAAO,CAAC,UAAU,KAAK,GAAG,EAAE;YAC/B,GAAG,CAAC,IAAI,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;YAE3B,IAAI,IAAI,CAAC,cAAc,EAAE;gBACxB,sDAAsD;gBACtD,8CAA8C;gBAC9C,KAAK,CAAC,oCAAoC,CAAC,CAAC;gBAC5C,OAAO,GAAG,CAAC,OAAO,CAAC;oBAClB,GAAG,IAAI,CACN,0BAA0B,CAAC,IAAI,CAAC,EAChC,MAAM,EACN,MAAM,EACN,MAAM,CACN;oBACD,MAAM;iBACN,CAAC,CAAC;aACH;YAED,OAAO,MAAM,CAAC;SACd;QAED,oEAAoE;QACpE,kEAAkE;QAClE,iEAAiE;QACjE,qBAAqB;QAErB,iEAAiE;QACjE,0DAA0D;QAC1D,oEAAoE;QACpE,mBAAmB;QACnB,EAAE;QACF,4CAA4C;QAC5C,MAAM,CAAC,OAAO,EAAE,CAAC;QAEjB,MAAM,UAAU,GAAG,IAAI,GAAG,CAAC,MAAM,CAAC,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC,CAAC;QACvD,UAAU,CAAC,QAAQ,GAAG,IAAI,CAAC;QAE3B,oEAAoE;QACpE,GAAG,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAa,EAAE,EAAE;YACpC,KAAK,CAAC,2CAA2C,CAAC,CAAC;YACnD,IAAA,gBAAM,EAAC,CAAC,CAAC,aAAa,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC;YAEpC,gEAAgE;YAChE,8DAA8D;YAC9D,YAAY;YACZ,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;YACjB,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACd,CAAC,CAAC,CAAC;QAEH,OAAO,UAAU,CAAC;IACnB,CAAC;;AA9IM,yBAAS,GAAG,CAAC,MAAM,EAAE,OAAO,CAAU,CAAC;AADlC,0CAAe;AAkJ5B,SAAS,MAAM,CAAC,MAAkC;IACjD,MAAM,CAAC,MAAM,EAAE,CAAC;AACjB,CAAC;AAED,SAAS,IAAI,CACZ,GAAM,EACN,GAAG,IAAO;IAIV,MAAM,GAAG,GAAG,EAEX,CAAC;IACF,IAAI,GAAqB,CAAC;IAC1B,KAAK,GAAG,IAAI,GAAG,EAAE;QAChB,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE;YACxB,GAAG,CAAC,GAAG,CAAC,GAAG,GAAG,CAAC,GAAG,CAAC,CAAC;SACpB;KACD;IACD,OAAO,GAAG,CAAC;AACZ,CAAC"} \ No newline at end of file diff --git a/node_modules/https-proxy-agent/package.json b/node_modules/https-proxy-agent/package.json index 3c793b76..51b7e117 100644 --- a/node_modules/https-proxy-agent/package.json +++ b/node_modules/https-proxy-agent/package.json @@ -1,6 +1,6 @@ { "name": "https-proxy-agent", - "version": "7.0.5", + "version": "7.0.6", "description": "An HTTP(s) proxy `http.Agent` implementation for HTTPS", "main": "./dist/index.js", "types": "./dist/index.d.ts", @@ -21,7 +21,7 @@ "author": "Nathan Rajlich (http://n8.io/)", "license": "MIT", "dependencies": { - "agent-base": "^7.0.2", + "agent-base": "^7.1.2", "debug": "4" }, "devDependencies": { diff --git a/node_modules/readable-stream/lib/internal/streams/end-of-stream.js b/node_modules/readable-stream/lib/internal/streams/end-of-stream.js index 29feb936..94d18321 100644 --- a/node_modules/readable-stream/lib/internal/streams/end-of-stream.js +++ b/node_modules/readable-stream/lib/internal/streams/end-of-stream.js @@ -1,12 +1,14 @@ +// Ported from https://github.com/mafintosh/end-of-stream with +// permission from the author, Mathias Buus (@mafintosh). + +'use strict' + /* replacement start */ const process = require('process/') /* replacement end */ -// Ported from https://github.com/mafintosh/end-of-stream with -// permission from the author, Mathias Buus (@mafintosh). -;('use strict') const { AbortError, codes } = require('../../ours/errors') const { ERR_INVALID_ARG_TYPE, ERR_STREAM_PREMATURE_CLOSE } = codes const { kEmptyObject, once } = require('../../ours/util') diff --git a/node_modules/readable-stream/lib/internal/streams/readable.js b/node_modules/readable-stream/lib/internal/streams/readable.js index 5b494ba3..90c73160 100644 --- a/node_modules/readable-stream/lib/internal/streams/readable.js +++ b/node_modules/readable-stream/lib/internal/streams/readable.js @@ -1,8 +1,3 @@ -/* replacement start */ - -const process = require('process/') - -/* replacement end */ // Copyright Joyent, Inc. and other Node contributors. // // Permission is hereby granted, free of charge, to any person obtaining a @@ -24,7 +19,14 @@ const process = require('process/') // OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE // USE OR OTHER DEALINGS IN THE SOFTWARE. -;('use strict') +'use strict' + +/* replacement start */ + +const process = require('process/') + +/* replacement end */ + const { ArrayPrototypeIndexOf, NumberIsInteger, @@ -65,7 +67,7 @@ const { } = require('../../ours/errors') const { validateObject } = require('../validators') const kPaused = Symbol('kPaused') -const { StringDecoder } = require('string_decoder') +const { StringDecoder } = require('string_decoder/') const from = require('./from') ObjectSetPrototypeOf(Readable.prototype, Stream.prototype) ObjectSetPrototypeOf(Readable, Stream) diff --git a/node_modules/readable-stream/lib/internal/streams/utils.js b/node_modules/readable-stream/lib/internal/streams/utils.js index 9ced0485..f0d7884e 100644 --- a/node_modules/readable-stream/lib/internal/streams/utils.js +++ b/node_modules/readable-stream/lib/internal/streams/utils.js @@ -30,7 +30,6 @@ function isReadableNodeStream(obj, strict = false) { ) // Writable has .pipe. ) } - function isWritableNodeStream(obj) { var _obj$_writableState return !!( @@ -45,7 +44,6 @@ function isWritableNodeStream(obj) { ) // Duplex ) } - function isDuplexNodeStream(obj) { return !!( obj && diff --git a/node_modules/readable-stream/lib/internal/streams/writable.js b/node_modules/readable-stream/lib/internal/streams/writable.js index 8a280034..b4ecf0e2 100644 --- a/node_modules/readable-stream/lib/internal/streams/writable.js +++ b/node_modules/readable-stream/lib/internal/streams/writable.js @@ -1,8 +1,3 @@ -/* replacement start */ - -const process = require('process/') - -/* replacement end */ // Copyright Joyent, Inc. and other Node contributors. // // Permission is hereby granted, free of charge, to any person obtaining a @@ -28,7 +23,14 @@ const process = require('process/') // Implement an async ._write(chunk, encoding, cb), and it'll handle all // the drain event emission and buffering. -;('use strict') +'use strict' + +/* replacement start */ + +const process = require('process/') + +/* replacement end */ + const { ArrayPrototypeSlice, Error, diff --git a/node_modules/readable-stream/lib/ours/errors.js b/node_modules/readable-stream/lib/ours/errors.js index 97866d14..979957e3 100644 --- a/node_modules/readable-stream/lib/ours/errors.js +++ b/node_modules/readable-stream/lib/ours/errors.js @@ -1,11 +1,12 @@ 'use strict' -const { format, inspect, AggregateError: CustomAggregateError } = require('./util') +const { format, inspect } = require('./util/inspect') +const { AggregateError: CustomAggregateError } = require('./primordials') /* This file is a reduced and adapted version of the main lib/internal/errors.js file defined at - https://github.com/nodejs/node/blob/master/lib/internal/errors.js + https://github.com/nodejs/node/blob/main/lib/internal/errors.js Don't try to replace with the original file and keep it up to date (starting from E(...) definitions) with the upstream file. @@ -311,7 +312,8 @@ E( received = addNumericalSeparator(String(input)) } else if (typeof input === 'bigint') { received = String(input) - if (input > 2n ** 32n || input < -(2n ** 32n)) { + const limit = BigInt(2) ** BigInt(32) + if (input > limit || input < -limit) { received = addNumericalSeparator(received) } received += 'n' diff --git a/node_modules/readable-stream/lib/ours/primordials.js b/node_modules/readable-stream/lib/ours/primordials.js index 00b82053..81856fcf 100644 --- a/node_modules/readable-stream/lib/ours/primordials.js +++ b/node_modules/readable-stream/lib/ours/primordials.js @@ -3,11 +3,28 @@ /* This file is a reduced and adapted version of the main lib/internal/per_context/primordials.js file defined at - https://github.com/nodejs/node/blob/master/lib/internal/per_context/primordials.js + https://github.com/nodejs/node/blob/main/lib/internal/per_context/primordials.js Don't try to replace with the original file and keep it up to date with the upstream file. */ + +// This is a simplified version of AggregateError +class AggregateError extends Error { + constructor(errors) { + if (!Array.isArray(errors)) { + throw new TypeError(`Expected input to be an Array, got ${typeof errors}`) + } + let message = '' + for (let i = 0; i < errors.length; i++) { + message += ` ${errors[i].stack}\n` + } + super(message) + this.name = 'AggregateError' + this.errors = errors + } +} module.exports = { + AggregateError, ArrayIsArray(self) { return Array.isArray(self) }, @@ -102,6 +119,6 @@ module.exports = { TypedArrayPrototypeSet(self, buf, len) { return self.set(buf, len) }, - Boolean: Boolean, + Boolean, Uint8Array } diff --git a/node_modules/readable-stream/lib/ours/util.js b/node_modules/readable-stream/lib/ours/util.js index 9896a1ce..b560361f 100644 --- a/node_modules/readable-stream/lib/ours/util.js +++ b/node_modules/readable-stream/lib/ours/util.js @@ -1,7 +1,11 @@ 'use strict' const bufferModule = require('buffer') -const { kResistStopPropagation, SymbolDispose } = require('./primordials') +const { format, inspect } = require('./util/inspect') +const { + codes: { ERR_INVALID_ARG_TYPE } +} = require('./errors') +const { kResistStopPropagation, AggregateError, SymbolDispose } = require('./primordials') const AbortSignal = globalThis.AbortSignal || require('abort-controller').AbortSignal const AbortController = globalThis.AbortController || require('abort-controller').AbortController const AsyncFunction = Object.getPrototypeOf(async function () {}).constructor @@ -24,22 +28,8 @@ const validateAbortSignal = (signal, name) => { } } const validateFunction = (value, name) => { - if (typeof value !== 'function') throw new ERR_INVALID_ARG_TYPE(name, 'Function', value) -} - -// This is a simplified version of AggregateError -class AggregateError extends Error { - constructor(errors) { - if (!Array.isArray(errors)) { - throw new TypeError(`Expected input to be an Array, got ${typeof errors}`) - } - let message = '' - for (let i = 0; i < errors.length; i++) { - message += ` ${errors[i].stack}\n` - } - super(message) - this.name = 'AggregateError' - this.errors = errors + if (typeof value !== 'function') { + throw new ERR_INVALID_ARG_TYPE(name, 'Function', value) } } module.exports = { @@ -83,50 +73,8 @@ module.exports = { debuglog() { return function () {} }, - format(format, ...args) { - // Simplified version of https://nodejs.org/api/util.html#utilformatformat-args - return format.replace(/%([sdifj])/g, function (...[_unused, type]) { - const replacement = args.shift() - if (type === 'f') { - return replacement.toFixed(6) - } else if (type === 'j') { - return JSON.stringify(replacement) - } else if (type === 's' && typeof replacement === 'object') { - const ctor = replacement.constructor !== Object ? replacement.constructor.name : '' - return `${ctor} {}`.trim() - } else { - return replacement.toString() - } - }) - }, - inspect(value) { - // Vastly simplified version of https://nodejs.org/api/util.html#utilinspectobject-options - switch (typeof value) { - case 'string': - if (value.includes("'")) { - if (!value.includes('"')) { - return `"${value}"` - } else if (!value.includes('`') && !value.includes('${')) { - return `\`${value}\`` - } - } - return `'${value}'` - case 'number': - if (isNaN(value)) { - return 'NaN' - } else if (Object.is(value, -0)) { - return String(value) - } - return value - case 'bigint': - return `${String(value)}n` - case 'boolean': - case 'undefined': - return String(value) - case 'object': - return '{}' - } - }, + format, + inspect, types: { isAsyncFunction(fn) { return fn instanceof AsyncFunction diff --git a/node_modules/readable-stream/lib/ours/util/inspect.js b/node_modules/readable-stream/lib/ours/util/inspect.js new file mode 100644 index 00000000..e0084457 --- /dev/null +++ b/node_modules/readable-stream/lib/ours/util/inspect.js @@ -0,0 +1,55 @@ +'use strict' + +/* + This file is a reduced and adapted version of the main lib/internal/util/inspect.js file defined at + + https://github.com/nodejs/node/blob/main/lib/internal/util/inspect.js + + Don't try to replace with the original file and keep it up to date with the upstream file. +*/ +module.exports = { + format(format, ...args) { + // Simplified version of https://nodejs.org/api/util.html#utilformatformat-args + return format.replace(/%([sdifj])/g, function (...[_unused, type]) { + const replacement = args.shift() + if (type === 'f') { + return replacement.toFixed(6) + } else if (type === 'j') { + return JSON.stringify(replacement) + } else if (type === 's' && typeof replacement === 'object') { + const ctor = replacement.constructor !== Object ? replacement.constructor.name : '' + return `${ctor} {}`.trim() + } else { + return replacement.toString() + } + }) + }, + inspect(value) { + // Vastly simplified version of https://nodejs.org/api/util.html#utilinspectobject-options + switch (typeof value) { + case 'string': + if (value.includes("'")) { + if (!value.includes('"')) { + return `"${value}"` + } else if (!value.includes('`') && !value.includes('${')) { + return `\`${value}\`` + } + } + return `'${value}'` + case 'number': + if (isNaN(value)) { + return 'NaN' + } else if (Object.is(value, -0)) { + return String(value) + } + return value + case 'bigint': + return `${String(value)}n` + case 'boolean': + case 'undefined': + return String(value) + case 'object': + return '{}' + } + } +} diff --git a/node_modules/readable-stream/lib/stream.js b/node_modules/readable-stream/lib/stream.js index b92b427b..1e2cab31 100644 --- a/node_modules/readable-stream/lib/stream.js +++ b/node_modules/readable-stream/lib/stream.js @@ -1,8 +1,3 @@ -/* replacement start */ - -const { Buffer } = require('buffer') - -/* replacement end */ // Copyright Joyent, Inc. and other Node contributors. // // Permission is hereby granted, free of charge, to any person obtaining a @@ -24,7 +19,14 @@ const { Buffer } = require('buffer') // OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE // USE OR OTHER DEALINGS IN THE SOFTWARE. -;('use strict') +'use strict' + +/* replacement start */ + +const { Buffer } = require('buffer') + +/* replacement end */ + const { ObjectDefineProperty, ObjectKeys, ReflectApply } = require('./ours/primordials') const { promisify: { custom: customPromisify } diff --git a/node_modules/readable-stream/package.json b/node_modules/readable-stream/package.json index c3d6f8a4..98b48e68 100644 --- a/node_modules/readable-stream/package.json +++ b/node_modules/readable-stream/package.json @@ -1,6 +1,6 @@ { "name": "readable-stream", - "version": "4.5.2", + "version": "4.7.0", "description": "Node.js Streams, a user-land copy of the stream library from Node.js", "homepage": "https://github.com/nodejs/readable-stream", "license": "MIT", @@ -33,7 +33,7 @@ "./lib/ours/index.js": "./lib/ours/browser.js" }, "scripts": { - "build": "node build/build.mjs", + "build": "node build/build.mjs 18.19.0", "postbuild": "prettier -w lib test", "test": "tap --rcfile=./tap.yml test/parallel/test-*.js test/ours/test-*.js", "test:prepare": "node test/browser/runner-prepare.mjs", @@ -42,6 +42,7 @@ "test:readable-stream-only": "node readable-stream-test/runner-prepare.mjs", "coverage": "c8 -c ./c8.json tap --rcfile=./tap.yml test/parallel/test-*.js test/ours/test-*.js", "format": "prettier -w src lib test", + "test:format": "prettier -c src lib test", "lint": "eslint src" }, "dependencies": { @@ -55,6 +56,7 @@ "@babel/core": "^7.17.10", "@babel/plugin-proposal-nullish-coalescing-operator": "^7.16.7", "@babel/plugin-proposal-optional-chaining": "^7.16.7", + "@eslint/eslintrc": "^3.2.0", "@rollup/plugin-commonjs": "^22.0.0", "@rollup/plugin-inject": "^4.0.4", "@rollup/plugin-node-resolve": "^13.3.0", diff --git a/node_modules/streamx/index.js b/node_modules/streamx/index.js index d16a0998..56e63fa3 100644 --- a/node_modules/streamx/index.js +++ b/node_modules/streamx/index.js @@ -98,6 +98,7 @@ const READ_READABLE_STATUS = OPEN_STATUS | READ_EMIT_READABLE | READ_QUEUED | RE const SHOULD_NOT_READ = OPEN_STATUS | READ_ACTIVE | READ_ENDING | READ_DONE | READ_NEEDS_PUSH | READ_READ_AHEAD const READ_BACKPRESSURE_STATUS = DESTROY_STATUS | READ_ENDING | READ_DONE const READ_UPDATE_SYNC_STATUS = READ_UPDATING | OPEN_STATUS | READ_NEXT_TICK | READ_PRIMARY +const READ_NEXT_TICK_OR_OPENING = READ_NEXT_TICK | OPENING // Combined write state const WRITE_PRIMARY_STATUS = OPEN_STATUS | WRITE_FINISHING | WRITE_DONE @@ -417,6 +418,12 @@ class ReadableState { else this.updateNextTick() } + updateNextTickIfOpen () { + if ((this.stream._duplexState & READ_NEXT_TICK_OR_OPENING) !== 0) return + this.stream._duplexState |= READ_NEXT_TICK + if ((this.stream._duplexState & READ_UPDATING) === 0) queueTick(this.afterUpdateNextTick) + } + updateNextTick () { if ((this.stream._duplexState & READ_NEXT_TICK) !== 0) return this.stream._duplexState |= READ_NEXT_TICK @@ -728,12 +735,12 @@ class Readable extends Stream { } push (data) { - this._readableState.updateNextTick() + this._readableState.updateNextTickIfOpen() return this._readableState.push(data) } unshift (data) { - this._readableState.updateNextTick() + this._readableState.updateNextTickIfOpen() return this._readableState.unshift(data) } @@ -1134,6 +1141,10 @@ function isReadStreamx (stream) { return isStreamx(stream) && stream.readable } +function isDisturbed (stream) { + return (stream._duplexState & OPENING) !== OPENING || (stream._duplexState & ACTIVE_OR_TICKING) !== 0 +} + function isTypedArray (data) { return typeof data === 'object' && data !== null && typeof data.byteLength === 'number' } @@ -1159,6 +1170,7 @@ module.exports = { isStreamx, isEnded, isFinished, + isDisturbed, getStreamError, Stream, Writable, diff --git a/node_modules/streamx/package.json b/node_modules/streamx/package.json index a7312c2f..151c0c6c 100644 --- a/node_modules/streamx/package.json +++ b/node_modules/streamx/package.json @@ -1,6 +1,6 @@ { "name": "streamx", - "version": "2.20.2", + "version": "2.21.1", "description": "An iteration of the Node.js core streams with a series of improvements", "main": "index.js", "dependencies": { diff --git a/node_modules/text-decoder/lib/pass-through-decoder.js b/node_modules/text-decoder/lib/pass-through-decoder.js index e29a9a44..57c99c12 100644 --- a/node_modules/text-decoder/lib/pass-through-decoder.js +++ b/node_modules/text-decoder/lib/pass-through-decoder.js @@ -1,3 +1,5 @@ +const b4a = require('b4a') + module.exports = class PassThroughDecoder { constructor (encoding) { this.encoding = encoding @@ -8,7 +10,7 @@ module.exports = class PassThroughDecoder { } decode (tail) { - return tail.toString(this.encoding) + return b4a.toString(tail, this.encoding) } flush () { diff --git a/node_modules/text-decoder/lib/utf8-decoder.js b/node_modules/text-decoder/lib/utf8-decoder.js index ef5d2c8e..5fdad67d 100644 --- a/node_modules/text-decoder/lib/utf8-decoder.js +++ b/node_modules/text-decoder/lib/utf8-decoder.js @@ -1,3 +1,5 @@ +const b4a = require('b4a') + /** * https://encoding.spec.whatwg.org/#utf-8-decoder */ @@ -23,7 +25,7 @@ module.exports = class UTF8Decoder { isBoundary = data[i] <= 0x7f } - if (isBoundary) return data.toString() + if (isBoundary) return b4a.toString(data, 'utf8') } let result = '' diff --git a/node_modules/text-decoder/package.json b/node_modules/text-decoder/package.json index c2cd86fb..f52080d0 100644 --- a/node_modules/text-decoder/package.json +++ b/node_modules/text-decoder/package.json @@ -1,6 +1,6 @@ { "name": "text-decoder", - "version": "1.2.1", + "version": "1.2.3", "description": "Streaming text decoder that preserves multibyte Unicode characters", "main": "index.js", "files": [ @@ -11,6 +11,10 @@ "./lib/pass-through-decoder.js": "./lib/browser-decoder.js", "./lib/utf8-decoder.js": "./lib/browser-decoder.js" }, + "react-native": { + "./lib/pass-through-decoder.js": "./lib/pass-through-decoder.js", + "./lib/utf8-decoder.js": "./lib/utf8-decoder.js" + }, "scripts": { "test": "standard && brittle test.js" }, @@ -24,6 +28,9 @@ "url": "https://github.com/holepunchto/text-decoder/issues" }, "homepage": "https://github.com/holepunchto/text-decoder#readme", + "dependencies": { + "b4a": "^1.6.4" + }, "devDependencies": { "brittle": "^3.3.2", "standard": "^17.0.0" diff --git a/node_modules/undici/lib/fetch/body.js b/node_modules/undici/lib/fetch/body.js index fd8481b7..4afcfdfb 100644 --- a/node_modules/undici/lib/fetch/body.js +++ b/node_modules/undici/lib/fetch/body.js @@ -22,6 +22,14 @@ const { isUint8Array, isArrayBuffer } = require('util/types') const { File: UndiciFile } = require('./file') const { parseMIMEType, serializeAMimeType } = require('./dataURL') +let random +try { + const crypto = require('node:crypto') + random = (max) => crypto.randomInt(0, max) +} catch { + random = (max) => Math.floor(Math.random(max)) +} + let ReadableStream = globalThis.ReadableStream /** @type {globalThis['File']} */ @@ -107,7 +115,7 @@ function extractBody (object, keepalive = false) { // Set source to a copy of the bytes held by object. source = new Uint8Array(object.buffer.slice(object.byteOffset, object.byteOffset + object.byteLength)) } else if (util.isFormDataLike(object)) { - const boundary = `----formdata-undici-0${`${Math.floor(Math.random() * 1e11)}`.padStart(11, '0')}` + const boundary = `----formdata-undici-0${`${random(1e11)}`.padStart(11, '0')}` const prefix = `--${boundary}\r\nContent-Disposition: form-data` /*! formdata-polyfill. MIT License. Jimmy Wärting */ diff --git a/node_modules/undici/package.json b/node_modules/undici/package.json index 65a2d983..0c6b71e1 100644 --- a/node_modules/undici/package.json +++ b/node_modules/undici/package.json @@ -1,6 +1,6 @@ { "name": "undici", - "version": "5.28.4", + "version": "5.28.5", "description": "An HTTP/1.1 client, written from scratch for Node.js", "homepage": "https://undici.nodejs.org", "bugs": { diff --git a/package-lock.json b/package-lock.json index 77edb62f..908acffb 100644 --- a/package-lock.json +++ b/package-lock.json @@ -14,9 +14,9 @@ } }, "node_modules/@actions/artifact": { - "version": "2.1.11", - "resolved": "https://registry.npmjs.org/@actions/artifact/-/artifact-2.1.11.tgz", - "integrity": "sha512-V/N/3yM3oLxozq2dpdGqbd/39UbDOR54bF25vYsvn3QZnyZERSzPjTAAwpGzdcwESye9G7vnuhPiKQACEuBQpg==", + "version": "2.2.1", + "resolved": "https://registry.npmjs.org/@actions/artifact/-/artifact-2.2.1.tgz", + "integrity": "sha512-V2cvKJ+Evg2n9Mcqz7kjbY2s0nd9MsBI2rw2E38pSEMv+Coo4i1sX0lyGcgSn1zyfVtmLwAI9LfuSptWF8PdaA==", "license": "MIT", "dependencies": { "@actions/core": "^1.10.0", @@ -132,9 +132,9 @@ } }, "node_modules/@actions/github/node_modules/@octokit/openapi-types": { - "version": "22.2.0", - "resolved": "https://registry.npmjs.org/@octokit/openapi-types/-/openapi-types-22.2.0.tgz", - "integrity": "sha512-QBhVjcUa9W7Wwhm6DBFu6ZZ+1/t/oYxqc2tp81Pi41YNuJinbFRx8B133qVOrAaBbF7D/m0Et6f9/pZt9Rc+tg==", + "version": "23.0.1", + "resolved": "https://registry.npmjs.org/@octokit/openapi-types/-/openapi-types-23.0.1.tgz", + "integrity": "sha512-izFjMJ1sir0jn0ldEKhZ7xegCTj/ObmEDlEfpFrx4k/JyZSMRHbO3/rBwgE7f3m2DHt+RrNGIVw4wSmwnm3t/g==", "license": "MIT" }, "node_modules/@actions/github/node_modules/@octokit/plugin-paginate-rest": { @@ -213,12 +213,12 @@ } }, "node_modules/@actions/github/node_modules/@octokit/types": { - "version": "13.6.2", - "resolved": "https://registry.npmjs.org/@octokit/types/-/types-13.6.2.tgz", - "integrity": "sha512-WpbZfZUcZU77DrSW4wbsSgTPfKcp286q3ItaIgvSbBpZJlu6mnYXAkjZz6LVZPXkEvLIM8McanyZejKTYUHipA==", + "version": "13.7.0", + "resolved": "https://registry.npmjs.org/@octokit/types/-/types-13.7.0.tgz", + "integrity": "sha512-BXfRP+3P3IN6fd4uF3SniaHKOO4UXWBfkdR3vA8mIvaoO/wLjGN5qivUtW0QRitBHHMcfC41SLhNVYIZZE+wkA==", "license": "MIT", "dependencies": { - "@octokit/openapi-types": "^22.2.0" + "@octokit/openapi-types": "^23.0.1" } }, "node_modules/@actions/http-client": { @@ -323,9 +323,9 @@ } }, "node_modules/@azure/core-rest-pipeline": { - "version": "1.18.1", - "resolved": "https://registry.npmjs.org/@azure/core-rest-pipeline/-/core-rest-pipeline-1.18.1.tgz", - "integrity": "sha512-/wS73UEDrxroUEVywEm7J0p2c+IIiVxyfigCGfsKvCxxCET4V/Hef2aURqltrXMRjNmdmt5IuOgIpl8f6xdO5A==", + "version": "1.18.2", + "resolved": "https://registry.npmjs.org/@azure/core-rest-pipeline/-/core-rest-pipeline-1.18.2.tgz", + "integrity": "sha512-IkTf/DWKyCklEtN/WYW3lqEsIaUDshlzWRlZNNwSYtFcCBQz++OtOjxNpm8rr1VcbMS6RpjybQa3u6B6nG0zNw==", "license": "MIT", "dependencies": { "@azure/abort-controller": "^2.0.0", @@ -577,18 +577,18 @@ } }, "node_modules/@octokit/request-error/node_modules/@octokit/openapi-types": { - "version": "22.2.0", - "resolved": "https://registry.npmjs.org/@octokit/openapi-types/-/openapi-types-22.2.0.tgz", - "integrity": "sha512-QBhVjcUa9W7Wwhm6DBFu6ZZ+1/t/oYxqc2tp81Pi41YNuJinbFRx8B133qVOrAaBbF7D/m0Et6f9/pZt9Rc+tg==", + "version": "23.0.1", + "resolved": "https://registry.npmjs.org/@octokit/openapi-types/-/openapi-types-23.0.1.tgz", + "integrity": "sha512-izFjMJ1sir0jn0ldEKhZ7xegCTj/ObmEDlEfpFrx4k/JyZSMRHbO3/rBwgE7f3m2DHt+RrNGIVw4wSmwnm3t/g==", "license": "MIT" }, "node_modules/@octokit/request-error/node_modules/@octokit/types": { - "version": "13.6.2", - "resolved": "https://registry.npmjs.org/@octokit/types/-/types-13.6.2.tgz", - "integrity": "sha512-WpbZfZUcZU77DrSW4wbsSgTPfKcp286q3ItaIgvSbBpZJlu6mnYXAkjZz6LVZPXkEvLIM8McanyZejKTYUHipA==", + "version": "13.7.0", + "resolved": "https://registry.npmjs.org/@octokit/types/-/types-13.7.0.tgz", + "integrity": "sha512-BXfRP+3P3IN6fd4uF3SniaHKOO4UXWBfkdR3vA8mIvaoO/wLjGN5qivUtW0QRitBHHMcfC41SLhNVYIZZE+wkA==", "license": "MIT", "dependencies": { - "@octokit/openapi-types": "^22.2.0" + "@octokit/openapi-types": "^23.0.1" } }, "node_modules/@octokit/request/node_modules/@octokit/request-error": { @@ -694,13 +694,10 @@ } }, "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==", + "version": "7.1.3", + "resolved": "https://registry.npmjs.org/agent-base/-/agent-base-7.1.3.tgz", + "integrity": "sha512-jRR5wdylq8CkOe6hei19GGZnxM6rBGwFl3Bg0YItGDimvjGtAvdZk4Pu6Cl4u4Igsws4a1fd1Vq3ezrhn4KmFw==", "license": "MIT", - "dependencies": { - "debug": "^4.3.4" - }, "engines": { "node": ">= 14" } @@ -784,9 +781,9 @@ "license": "MIT" }, "node_modules/bare-events": { - "version": "2.5.0", - "resolved": "https://registry.npmjs.org/bare-events/-/bare-events-2.5.0.tgz", - "integrity": "sha512-/E8dDe9dsbLyh2qrZ64PEPadOQ0F4gbl1sUJOrmph7xOiIxfY8vwab/4bFLh4Y88/Hk/ujKcrQKc+ps0mv873A==", + "version": "2.5.4", + "resolved": "https://registry.npmjs.org/bare-events/-/bare-events-2.5.4.tgz", + "integrity": "sha512-+gFfDkR8pj4/TrWCGUGWmJIkBwuxPS5F+a5yWjOHQt2hHvNZd5YLzadjmDUtFmMM4y429bnKLa8bYBMHcYdnQA==", "license": "Apache-2.0", "optional": true }, @@ -1002,9 +999,9 @@ } }, "node_modules/debug": { - "version": "4.3.7", - "resolved": "https://registry.npmjs.org/debug/-/debug-4.3.7.tgz", - "integrity": "sha512-Er2nc/H7RrMXZBFCEim6TCmMk02Z8vLC2Rbi1KEBggpo0fS6l0S1nnapwmIi3yW/+GOJap1Krg4w0Hg80oCqgQ==", + "version": "4.4.0", + "resolved": "https://registry.npmjs.org/debug/-/debug-4.4.0.tgz", + "integrity": "sha512-6WTZ/IxCY/T6BALoZHaE4ctp9xm+Z5kY/pzYaCHRFeyVhojxlrm+46y68HA6hr0TcwEssoxNiDEUJQjfPZ/RYA==", "license": "MIT", "dependencies": { "ms": "^2.1.3" @@ -1117,9 +1114,9 @@ "license": "MIT" }, "node_modules/fast-xml-parser": { - "version": "4.5.0", - "resolved": "https://registry.npmjs.org/fast-xml-parser/-/fast-xml-parser-4.5.0.tgz", - "integrity": "sha512-/PlTQCI96+fZMAOLMZK4CWG1ItCbfZ/0jx7UIJFChPNrx7tcEgerUgWbeieCM9MfHInUDyK8DWYZ+YrywDJuTg==", + "version": "4.5.1", + "resolved": "https://registry.npmjs.org/fast-xml-parser/-/fast-xml-parser-4.5.1.tgz", + "integrity": "sha512-y655CeyUQ+jj7KBbYMc4FG01V8ZQqjN+gDYGJ50RtfsUB8iG9AmwmwoAgeKLJdmueKKMrH1RJ7yXHTSoczdv5w==", "funding": [ { "type": "github", @@ -1209,12 +1206,12 @@ } }, "node_modules/https-proxy-agent": { - "version": "7.0.5", - "resolved": "https://registry.npmjs.org/https-proxy-agent/-/https-proxy-agent-7.0.5.tgz", - "integrity": "sha512-1e4Wqeblerz+tMKPIq2EMGiiWW1dIjZOksyHWSUm1rmuvw/how9hBHZ38lAGj5ID4Ik6EdkOw7NmWPy6LAwalw==", + "version": "7.0.6", + "resolved": "https://registry.npmjs.org/https-proxy-agent/-/https-proxy-agent-7.0.6.tgz", + "integrity": "sha512-vK9P5/iUfdl95AI+JVyUuIcVtd4ofvtrOr3HNtM2yxC9bnMbEdp3x01OhQNnjb8IJYi38VlTE3mBXwcfvywuSw==", "license": "MIT", "dependencies": { - "agent-base": "^7.0.2", + "agent-base": "^7.1.2", "debug": "4" }, "engines": { @@ -1576,9 +1573,9 @@ "license": "MIT" }, "node_modules/readable-stream": { - "version": "4.5.2", - "resolved": "https://registry.npmjs.org/readable-stream/-/readable-stream-4.5.2.tgz", - "integrity": "sha512-yjavECdqeZ3GLXNgRXgeQEdz9fvDDkNKyHnbHRFtOr7/LcfgBcmct7t/ET+HaCTqfh06OzoAxrkN/IfjJBVe+g==", + "version": "4.7.0", + "resolved": "https://registry.npmjs.org/readable-stream/-/readable-stream-4.7.0.tgz", + "integrity": "sha512-oIGGmcpTLwPga8Bn6/Z75SVaH1z5dUut2ibSyAMVhmUggWpmDn2dapB0n7f8nwaSiRtepAsfJyfXIO5DCVAODg==", "license": "MIT", "dependencies": { "abort-controller": "^3.0.0", @@ -1666,9 +1663,9 @@ } }, "node_modules/streamx": { - "version": "2.20.2", - "resolved": "https://registry.npmjs.org/streamx/-/streamx-2.20.2.tgz", - "integrity": "sha512-aDGDLU+j9tJcUdPGOaHmVF1u/hhI+CsGkT02V3OKlHDV7IukOI+nTWAGkiZEKCO35rWN1wIr4tS7YFr1f4qSvA==", + "version": "2.21.1", + "resolved": "https://registry.npmjs.org/streamx/-/streamx-2.21.1.tgz", + "integrity": "sha512-PhP9wUnFLa+91CPy3N6tiQsK+gnYyUNuk15S3YG/zjYE7RuPeCjJngqnzpC31ow0lzBHQ+QGO4cNJnd0djYUsw==", "license": "MIT", "dependencies": { "fast-fifo": "^1.3.2", @@ -1802,10 +1799,13 @@ } }, "node_modules/text-decoder": { - "version": "1.2.1", - "resolved": "https://registry.npmjs.org/text-decoder/-/text-decoder-1.2.1.tgz", - "integrity": "sha512-x9v3H/lTKIJKQQe7RPQkLfKAnc9lUTkWDypIQgTzPJAq+5/GCDHonmshfvlsNSj58yyshbIJJDLmU15qNERrXQ==", - "license": "Apache-2.0" + "version": "1.2.3", + "resolved": "https://registry.npmjs.org/text-decoder/-/text-decoder-1.2.3.tgz", + "integrity": "sha512-3/o9z3X0X0fTupwsYvR03pJ/DjWuqqrfwBgTQzdWDiQSm9KitAyz/9WqsT2JQW7KV2m+bC2ol/zqpW37NHxLaA==", + "license": "Apache-2.0", + "dependencies": { + "b4a": "^1.6.4" + } }, "node_modules/tr46": { "version": "0.0.3", @@ -1890,9 +1890,9 @@ } }, "node_modules/undici": { - "version": "5.28.4", - "resolved": "https://registry.npmjs.org/undici/-/undici-5.28.4.tgz", - "integrity": "sha512-72RFADWFqKmUb2hmmvNODKL3p9hcB6Gt2DOQMis1SEBaV6a4MH8soBvzg+95CYhCKPFedut2JY9bMfrDl9D23g==", + "version": "5.28.5", + "resolved": "https://registry.npmjs.org/undici/-/undici-5.28.5.tgz", + "integrity": "sha512-zICwjrDrcrUE0pyyJc1I2QzBkLM8FINsgOrt6WjA+BgajVq9Nxu2PbFFXUrAggLfDXlZGZBVZYw7WNV5KiBiBA==", "license": "MIT", "dependencies": { "@fastify/busboy": "^2.0.0"